Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

53 lines (32 loc) · 2.17 KB
Raw

Contributing

Welcome to our project! We appreciate your interest in contributing. Here are some guidelines to help you get started.

Communication Style

  1. Leave Screenshots: Visual changes require screenshots for clarity.
  2. Detailed Pull Request Description: Provide a detailed description in your Pull Request. Leave nothing ambiguous for the reviewer.
  3. Code Review Comments: Review your code first and leave comments noting questions or interesting points for the reviewer.
  4. Active Communication: Whether in issues or pull requests, keeping the lines of communication open helps everyone.

Setup

Forks are preferred. Follow these steps to set up the project:

$ git clone https://github.com/<your-name>/project-aqua
$ cd <project-name>
$ npm install

Building

$ npm run build

PR Validation

Examples for valid PR titles:

  • fix: Correct typo.
  • feat: Add support for Node 12.

See Conventional Commits for more examples.

Work in progress

GitHub has support for draft pull requests, which will disable the merge button until the PR is marked as ready for merge. Furthermore, add the 🚧 Work in Progress label to your PR.

Issues

If you plan to contribute a change based on an open issue, please assign yourself. Issues that are not assigned are assumed open, and to avoid conflicts, please assign yourself before beginning work on any issues.

If you would like to contribute to the project for the first time, please consider joining checking the help wanted, 🚀 Good first issue, or 🐛 Bug labels.

Community

Do you have questions? Join the conversation in our discussions.

License

Project Aqua is open-source under the GNU Affero General Public License Version 3 (AGPLv3) or any later version.