Visitar URL original
appwrite/CONTRIBUTING.md at main · appwrite/appwrite · GitHub
Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (36 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 3.49 KB
Raw

Contributing

We would ❤️ you to contribute to Appwrite and help make it better. All contributions are welcome: issues, docs, code, blog posts, workshops, and more.

Coding conventions, architecture, tests, and how to run the stack live in AGENTS.md. That file is the coding contract for every contributor, human or agent. Using AI does not lower the bar: you own the pull request, you must follow those standards, and you must review and oversee any agent-generated work against them. The same rules apply whether you write the code yourself or with an assistant.

The SDK release how-to is in docs/tutorials/release-sdks.md. The Console UI is a separate repository.

Here for Hacktoberfest?

Appwrite only accepts Hacktoberfest contributions on issues labeled hacktoberfest. Find those issues.

How to Start

Follow these steps before writing any code:

  1. Find an issue. Prefer good first issue or help wanted. If you are unsure, ask in the maintainers channel on Discord.
  2. Ask to be assigned. Comment on the GitHub issue, then open a Discord thread in the maintainers channel with a link to it. The team is small and may miss GitHub comments.
  3. Do not submit unsolicited PRs. If you are not working on an assigned issue, open a GitHub issue first. Large features should be discussed on that issue; some need an RFC. PRs without context may be closed without review.

We can only review contributions that follow this process.

Code of Conduct

Please read and follow our Code of Conduct.

Submit a Pull Request

Branch names follow TYPE-ISSUE_ID-DESCRIPTION, for example doc-548-submit-a-pull-request-section-to-contribution-guide.

TYPE is one of:

  • feat — a new feature
  • doc — documentation only
  • cicd — CI/CD
  • fix — a bug fix
  • refactor — neither a fix nor a feature

Every PR needs a commit message that describes the change.

  1. Fork the repo and keep your default branch up to date (git pull).
  2. Create a branch from master with the naming convention above.
  3. Make commits on that branch. Follow AGENTS.md for format, tests, and architecture — including when an agent drafted the change. You still review it.
  4. Push and open a pull request against this repository.
  5. Wait for a core developer to review. After approval, the PR can be merged; GitHub deletes the branch.

Other Ways to Help

Pull requests are great, but you can also:

  • Write or speak about Appwrite, mention @appwrite, and add posts or talks to Awesome Appwrite.
  • Present at meetups and conferences; we are happy to review talk abstracts.
  • Report bugs and share feedback on GitHub or Discord.
  • Open an issue for a new idea so the community can discuss it.
  • Improve documentation (including spelling and grammar).
  • Help someone else on Discord, GitHub, or Stack Overflow.