This document describes the general flow for contributing to APISIX repos.
Any and all forms of contributions are welcome! For example you can,
Join the discussions on the mailing list.
Review open pull requests.
Improve the website.
Improve documentation or write a blog post.
Any other form of code or non-code contribution.
If you would like to contribute, let us know by sending an email to email@example.com!
You can also contribute by fixing one of the open issues.
Please check to see if the issue is already being worked on and indicate when you will be able to complete it.
Connect with a Committer or PMC for providing feedback on your issue and reviewing your PR.
Issues labelled "good first issues" are low hanging fruits that are easy to fix. These issues can help you make your first contributions to APISIX.
To start, you can go through this curated list of "good first issues".
To contribute code or documentation, setup your local machine for development.
Fork the APISIX repo and clone your fork to your local machine.
git clone https://github.com/your-username/apisix.git
Check to see if the upstream repo has been configured by listing the remotes.
git remote -v
If not, you can add the upstream remote.
git remote add upstream https://github.com/apache/apisix.git
Learn more about Git and GitHub flow by following the GitHub Docs.
Note: Setup your name and email address to make sure that your ID shows up in the contributor list.
git config --global user.name "full name"git config --global user.email "mail address"
To keep your local fork up to date, fetch and rebase with the upstream remote.
git fetch upstreamgit checkout mastergit rebase upstream/mastergit push origin master
Then, to make changes, create a new branch in your local fork.
git checkout -b issue-no
Note: The commits in a PR are squashed before merging. This could result in commit logs different from upstream if you are using an older branch.
Contributors are expected to adhere to the Code of Conduct throughout the process.
Once you make the changes, commit the files and push the changes to your fork.
$ git add modified-file-names$ git commit -m 'commit message'$ git push origin issue-no
Once you have your changes pushed to your fork, it is time to start the process of merging it to upstream by opening a pull request.
See GitHub flow for detailed instructions on making a pull request.
Open a pull request to the master branch.
Make sure that the pull request title has a semantic prefix like
feat:or any other conventional commit types.
Reach out to your mentor for starting the review process.
Engage in discussions and provide clarifications to reviewers' questions.
Wait for your PR to be approved and merged.
Congratulate yourself for being an official contributor of Apache APISIX!
Two-Factor Authentication (2FA) refers to the authentication method that combines both a password and an object (credit card, SMS, tokens, or biomarkers as fingerprint) to identify a user.
To ensure the security of the committer’s account, we need you to configure 2FA while signing in to contribute code on GitHub. For more details, please refer to Securing your account with two-factor authentication (2FA).
Note: If 2FA is not enabled, you are liable to be removed from the project and would not be able to access Apache APISIX's repositories.
GitHub recommends using a time-based-one-time password (TOTP) mobile application to configure 2FA. Read Configuring two-factor authentication for detailed information.
After enabling 2FA, create a personal access token to perform Git operations.
You can then use the username + personal access token combination in place of the username + password combination while pushing your code.