Firstly, thanks for your interest in contributing! I hope that this will be a pleasant first experience for you, and that you will return to continue contributing.
Most of the contributions that we receive are code contributions, but you can also contribute to the documentation or simply report solid bugs for us to fix.
For new contributors, please take a look at issues with a tag called Good first issue or Help wanted.
Ensure the bug was not already reported by searching on GitHub under Issues.
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
Before making any significant changes, please open an issue. Discussing your proposed changes ahead of time will make the contribution process smooth for everyone.
Once we‘ve discussed your changes and you’ve got your code ready, make sure that tests are passing and open your pull request. Your PR is most likely to be accepted if it:
types
section of semantic.yml.Linting/Style
For linting both our Markdown and YAML files we use:
Active Voice
In general, use active voice when formulating the sentence instead of passive voice. A sentence written in the active voice will emphasize the person or thing who is performing an action (eg.The dog chased the ball). In contrast, the passive voice will highlight the recipient of the action (The ball was chased by the dog). Therefore use the passive voice, only when it's less important who or what completed the action and more important that the action was completed. For example:
Capitalization:
For titles of a section, capitalize the first letter of each word except for the closed-class words such as determiners, pronouns, conjunctions, and prepositions. Use the following link for guidance.
For normal sentences, don't capitalize random words in the middle of the sentences. Use the Chicago manual for capitalization rules for the documentation.
Second Person
In general, use second person in your docs rather than first person. For example:
Spellings
Use American spellings when contributing to the documentation.
Voice
make lint
.# install `luacheck` first before run it $ luarocks install luacheck # check source code $ make lint ./utils/check-lua-code-style.sh + luacheck -q apisix t/lib Total: 0 warnings / 0 errors in 146 files + find apisix -name *.lua ! -wholename apisix/cli/ngx_tpl.lua -exec ./utils/lj-releng {} + + grep -E ERROR.*.lua: /tmp/check.log + true + [ -s /tmp/error.log ] ./utils/check-test-code-style.sh + find t -name '*.t' -exec grep -E '\-\-\-\s+(SKIP|ONLY|LAST|FIRST)$' '{}' + + true + '[' -s /tmp/error.log ']' + find t -name '*.t' -exec ./utils/reindex '{}' + + grep done. /tmp/check.log + true + '[' -s /tmp/error.log ']'
The `lj-releng` and `reindex` will be downloaded automatically by `make lint` if not exists.
make lint
.t/plugin/limit-conn.t
and t/plugin/limit-conn2.t
.apisix
channel at Apache Slack. If the link is not working, find the latest one at Apache INFRA WIKI.