Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (30 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 1.94 KB
Raw

Aster

Contributing to Aster

Thank you for your interest in contributing to Aster. We welcome contributions of all kinds.

Reporting bugs

If you find a bug in one of our services, open an issue on the relevant repository. Include as much detail as possible:

  • What you expected to happen
  • What actually happened
  • Steps to reproduce the bug
  • Your operating system, browser, app version, and any other relevant details

Don't open a public issue for a security vulnerability. Read our security policy for instructions on how to report one.

Suggesting features

Open an issue with the label suggestion. Describe the problem you are trying to solve, not only the solution, so we understand the use case behind the suggestion.

Submitting a pull request

  1. Fork the relevant repository.
  2. Create a new branch: git checkout -b your-feature-name.
  3. Make your changes.
  4. Test your changes end to end.
  5. Commit your changes with a clear message (see below).
  6. Open a pull request against main.

Keep each pull request on topic. One feature or fix per pull request makes review much faster.

Commit messages

Use clear, descriptive commit messages in the imperative mood:

  • Add support for custom domain DNS checks
  • Fix subject line encryption in the reply, compose, and forward modals
  • Update the readme to fix spelling and grammar

Avoid vague messages like fixed stuff or small updates.

License

Aster's application code is licensed under AGPL v3. By contributing to an Aster repository, you agree that your contributions are licensed under that repository's license.

Questions?

Join our Discord if you want to discuss something before opening an issue or pull request.