Branch

Commit

Hash : 42cc731b
Author :
Date : 2019-03-10T19:51:44

Update documentation [ci skip]

The documentation for building and installing has been moved into a new
Documentation section

Closes: #788 (cherry-picked)

Contributing to libevent

Coding style

First and most generic rule: just look around.

But, we have a script for checking patches/files/git-refs:

# Chech HEAD git ref
./checkpatch.sh -r
./checkpatch.sh -r HEAD

# Check patch
git format-patch --stdout -1 | ./checkpatch.sh -p
git show -1 | ./checkpatch.sh -p

# Or via regular files
git format-patch --stdout -2
./checkpatch.sh *.patch

# Over a file
./checkpatch.sh -d event.c
./checkpatch.sh -d < event.c

# And print the whole file not only summary
./checkpatch.sh -f event.c
./checkpatch.sh -f < event.c

# See
./checkpatch.sh -h

Testing

Write new unit test in test/regress_{MORE_SUITABLE_FOR_YOU}.c
make verify

Asking Questions

It’s all right to have questions! Instead of filing an issue here, go ahead and leave a message in our Gitter Room

Source

CONTRIBUTING.md

# Contributing to libevent

## Coding style

First and most generic rule: **just look around**.

But, we have a script for checking patches/files/git-refs:
```shell
# Chech HEAD git ref
./checkpatch.sh -r
./checkpatch.sh -r HEAD

# Check patch
git format-patch --stdout -1 | ./checkpatch.sh -p
git show -1 | ./checkpatch.sh -p

# Or via regular files
git format-patch --stdout -2
./checkpatch.sh *.patch

# Over a file
./checkpatch.sh -d event.c
./checkpatch.sh -d < event.c

# And print the whole file not only summary
./checkpatch.sh -f event.c
./checkpatch.sh -f < event.c

# See
./checkpatch.sh -h
```

## Testing
- Write new unit test in `test/regress_{MORE_SUITABLE_FOR_YOU}.c`
- `make verify`

## Asking Questions
It's all right to have questions! Instead of filing an issue here, go ahead and leave a message in our [Gitter Room](https://gitter.im/libevent/libevent)