xref: /aosp_15_r20/external/libwebsockets/READMEs/README.contributing.md (revision 1c60b9aca93fdbc9b5f19b2d2194c91294b22281)
1*1c60b9acSAndroid Build Coastguard Worker## Contributing to lws
2*1c60b9acSAndroid Build Coastguard Worker
3*1c60b9acSAndroid Build Coastguard Worker### How to contribute
4*1c60b9acSAndroid Build Coastguard Worker
5*1c60b9acSAndroid Build Coastguard WorkerSending a patch with a bug report is very welcome.
6*1c60b9acSAndroid Build Coastguard Worker
7*1c60b9acSAndroid Build Coastguard WorkerFor nontrivial problems, it's probably best to discuss on the mailing list,
8*1c60b9acSAndroid Build Coastguard Workeror on github if you prefer, how to best solve it.
9*1c60b9acSAndroid Build Coastguard Worker
10*1c60b9acSAndroid Build Coastguard WorkerHowever your contribution is coming is fine:
11*1c60b9acSAndroid Build Coastguard Worker
12*1c60b9acSAndroid Build Coastguard Worker - paste a `git diff`
13*1c60b9acSAndroid Build Coastguard Worker
14*1c60b9acSAndroid Build Coastguard Worker - send a patch series by mail or mailing list
15*1c60b9acSAndroid Build Coastguard Worker
16*1c60b9acSAndroid Build Coastguard Worker - paste in a github issue
17*1c60b9acSAndroid Build Coastguard Worker
18*1c60b9acSAndroid Build Coastguard Worker - github PR
19*1c60b9acSAndroid Build Coastguard Worker
20*1c60b9acSAndroid Build Coastguard Workerare all OK.
21*1c60b9acSAndroid Build Coastguard Worker
22*1c60b9acSAndroid Build Coastguard Worker### Coding Standards
23*1c60b9acSAndroid Build Coastguard Worker
24*1c60b9acSAndroid Build Coastguard WorkerCode should look roughly like the existing code, which follows linux kernel
25*1c60b9acSAndroid Build Coastguard Workercoding style.
26*1c60b9acSAndroid Build Coastguard Worker
27*1c60b9acSAndroid Build Coastguard WorkerIf there are non-functional problems I will clean them out when I apply the
28*1c60b9acSAndroid Build Coastguard Workerpatch.
29*1c60b9acSAndroid Build Coastguard Worker
30*1c60b9acSAndroid Build Coastguard WorkerIf there are functional problems (eg broken error paths etc) if they are
31*1c60b9acSAndroid Build Coastguard Workersmall compared to the working part I will also clean them.  If there are
32*1c60b9acSAndroid Build Coastguard Workerlarger problems, or consequences to the patch will have to discuss how to
33*1c60b9acSAndroid Build Coastguard Workersolve them with a retry.
34*1c60b9acSAndroid Build Coastguard Worker
35*1c60b9acSAndroid Build Coastguard Worker### Funding specific work
36*1c60b9acSAndroid Build Coastguard Worker
37*1c60b9acSAndroid Build Coastguard WorkerIf there is a feature you wish was supported in lws, consider paying for the
38*1c60b9acSAndroid Build Coastguard Workerwork to be done.  The maintainer is a consultant and if we can agree the
39*1c60b9acSAndroid Build Coastguard Workertask, you can quickly get a high quality result that does just what you need,
40*1c60b9acSAndroid Build Coastguard Workermaintained ongoing along with the rest of lws.
41*1c60b9acSAndroid Build Coastguard Worker
42