libwebsockets/READMEs/README.contributing.md
2018-10-13 08:16:27 +08:00

42 lines
1.1 KiB
Markdown

## Contributing to lws
### How to contribute
Sending a patch with a bug report is very welcome.
For nontrivial problems, it's probably best to discuss on the mailing list,
or on github if you prefer, how to best solve it.
However your contribution is coming is fine:
- paste a `git diff`
- send a patch series by mail or mailing list
- paste in a github issue
- github PR
are all OK.
### Coding Standards
Code should look roughly like the existing code, which follows linux kernel
coding style.
If there are non-functional problems I will clean them out when I apply the
patch.
If there are functional problems (eg broken error paths etc) if they are
small compared to the working part I will also clean them. If there are
larger problems, or consequences to the patch will have to discuss how to
solve them with a retry.
### Funding specific work
If there is a feature you wish was supported in lws, consider paying for the
work to be done. The maintainer is a consultant and if we can agree the
task, you can quickly get a high quality result that does just what you need,
maintained ongoing along with the rest of lws.