Skip to content

Latest commit

 

History

History
103 lines (63 loc) · 4.12 KB

CONTRIBUTING.md

File metadata and controls

103 lines (63 loc) · 4.12 KB
Raw

Contributing

We would ❤️ you to contribute to the Appwrite website and help make it better! We want contributing to Appwrite to be fun, enjoyable, and educational for anyone and everyone. This document will walk you through the steps to complete your first contribution.

Code of conduct

Help us keep Appwrite open and inclusive. Before interacting with the Appwrite community, please read and follow our Code of Conduct.

Find an issue

Looking for a place to start? Have a feature request or bug report? Start with by searching through our issues.

If you're looking for a good issue to start contributing, simple issues fit for first time contributors will be labelled good first issue. More challenging issues might be labelled help wanted.

If you want to request features, improvements, or bug fixes, search for existing issues first. If you find a similar issue, comment and upvote the issue for visibility. If you cannot find a similar issues, open a new issue. If the Appwrite maintainers think the issue is an issue appropriate for contribution, we'll mark it as help wanted.

Fork and clone

To contribute to the Appwrite website, you need to fork, clone, and run the website.

Start by forking the repository, which makes a copy of the repo on your GitHub profile. This allows you to make code changes when you don't have permissions in the main Appwrite website repo.

Then, clone the respository.

Alternatively, you can develop the website repo in your browser using Code Spaces or GitPod.

Development

The Appwrite website uses PNPM. Start by following their installation documentation.

Once you've cloned the Appwrite website repo, running the following command to install dependencies:

pnpm i

Then, run the following command to start a development server.

pnpm run dev

Before commiting your code changes, make sure the website repo builds by running:

pnpm run build

Submit a pull request 🚀

The branch naming convention is as follows

TYPE-ISSUE_ID-DESCRIPTION

example:

doc-548-submit-a-pull-request-section-to-contribution-guide

When 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 with a description of 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:

  1. Before creating a new branch, pull the changes from upstream to make sure your default branch is up to date.
git pull
  1. 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]
  1. Work - commit - repeat ( be sure to be in your branch )
  2. Push changes to GitHub
git push origin [name_of_your_new_branch]
  1. Submit your changes for review. If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.
  2. Start a Pull Request (PR) by clicking on Create pull request. Make sure to update the PR description following the template provided.
  3. Wait for a code review.
  4. If you need to make changes based on feedback, make sure to re-request a review from your reviewer after you've made the necessary changes.

Re-Request a Review

  1. After approval, your PR will be merged.

Documentation style

When contributing to the Appwrite docs, follow the guide in STYLE.md.