We would ❤️ for you to contribute to Appwrite and help make it better! We want contributing to Appwrite to be fun, enjoyable, and educational for anyone and everyone. All contributions, including issues, new docs, updated docs, blog posts, workshops, and more, are welcome.
If you are worried or need help figuring out where to start, check out our next section explaining what kind of help is needed and where you can get involved. You can reach out with questions on our Discord server. You can also submit an issue, and a maintainer can guide you!
Help us keep Appwrite open and inclusive. Please read and follow our Code of Conduct.
Our branch naming convention is as follows:
TYPE-ISSUE_ID-DESCRIPTION
example:
doc-548-submit-a-pull-request-section-to-contribution-guide
Where TYPE can be:
- feat - is a new feature
- doc - documentation only changes
- cicd - changes related to CI/CD system
- fix - a bug fix
- refactor - code change that neither fixes a bug nor adds a feature
All PRs must include a commit message describing the changes made!
Start by forking the project and use the git clone command to download the repository to your computer. A standard procedure for working on an issue would be to:
- Before creating a new branch, pull the changes from upstream to ensure your default branch is up to date.
$ git pull
- Create a new branch from the default branch. For example
doc-548-submit-a-pull-request-section-to-contribution-guide
$ git checkout -b [name_of_your_new_branch]
- Work - commit - repeat ( be sure to be in your branch )
- Push changes to GitHub
$ git push origin [name_of_your_new_branch]
- Submit your changes for review. If you go to your repository on GitHub, you'll see a
Compare & pull requestbutton. Click on that button. - Start a Pull Request (PR) by clicking on
Create pull request. Make sure to update the PR description following the template provided. - Wait for a code review.
- If you need to make changes based on feedback, re-request your reviewer's review after you've made the necessary changes.
- After approval, a maintainer will merge your PR.
- After a maintainer merges your PR, you may delete your
We would 💖 you to contribute to Appwrite, but we would also like to make sure Appwrite is as great as possible and loyal to its vision and mission statement 🙏.
For us to find the right balance, please open an issue explaining your ideas before introducing a new pull request.
An issue will allow the Appwrite community to thoroughly discuss the new feature and how it fits into the product roadmap and vision.
An issue is also essential for Appwrite maintainers to discuss the feature's design and architecture to help the contribution fit in organically in the Appwrite codebase. Some more extensive features might need to go through our RFC process.
Pull requests are great, but there are many other areas where you can help Appwrite.
When blogging, speaking about, or creating tutorials about one of Appwrite's many features, mention @appwrite on Twitter and/or email team@appwrite.io so we can give pointers and tips and help you spread the word by promoting your content on the different Appwrite communication channels. Please add your blog posts and videos of talks to our Awesome Appwrite repo on GitHub.
Your unique challenges and successes in building things with Appwrite can provide great speaking material. We’d love to review your talk abstract/CFP, so contact us if you’d like some help!
Sending feedback is an excellent way for us to understand different use cases for Appwrite. If you have any issues or want to share your experience, feel free to do so on our GitHub issues page or our Discord channel.
Submitting documentation updates, enhancements, designs, or bug fixes will be very much appreciated.
Help someone on Discord, GitHub, or StackOverflow. You can also help by teaching others how to contribute to Appwrite's repo!