Skip to content

Latest commit

 

History

History
66 lines (49 loc) · 3.71 KB

CONTRIBUTING.md

File metadata and controls

66 lines (49 loc) · 3.71 KB

Contributing

Before contributing, please read carefully our Contributor Licence Agreement. When you make a PR for the first time, you will automatically be asked to agree to and sign the CLA by making a comment affirming your agreement. If you are contributing in another way and still need to sign the agreement, you may open a new PR to sign it.

When contributing to this repository, please first discuss the change you wish to make via issue or any other available method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Ways to contribute

Help others

Helping out with support in the discord server or discussions.

Analyzing issues

Analyzing issues involves helping to solve issues.

This could involve such things as figuring out how to reproduce it, finding the fix to it, giving additional information, or a hint which helps to understand it more.

Reporting issues

If you find a bug, you are welcome to report it. We can only handle well-reported, actual bugs, so please follow the guidelines below.

Once you have familiarized with the guidelines, you can go to the issue tracker to report the issue.

Quick Checklist for Bug Reports:

Issue report checklist:

  • Real, current bug
  • No duplicate
  • Reproducible
  • Good summary
  • Well-documented
  • Minimal example

Working on issues

Find or create an issue you are interested in working on. On the issue, let the project members know you want to work on that particular issue, and if agreed, you will be assigned to the issue. Please also discuss what changes you want to make, design decisions, or any other pertinent details with project members so you can ensure that none of your or our time is wasted.

Contributing code

These are some of the rules we try to follow:

  • Apply a clean coding style adapted to the surrounding code
  • Use same indentation as surrounding project/code
  • Use variable naming conventions like in the other files you are seeing (camelcase)
  • Comment your code where it gets non-trivial
  • Keep an eye on performance and memory consumption
  • Keep a careful eye out for compatibility with previous code. Especially if it has to do with public apis.
  • Maintain high code quality. Please ensure your code is - to the best of your ability - readable, well-formed, and documented.
  • Please ensure you have handled any lint warnings in the appropriate project(s). If you have a reason the lint should be allowed, then please explicitly allow the lint(s) so they no longer trigger a warning. Note that allowing a lint should only be done when there's a very good reason.

Pull Request Process

  1. Ensure any extraneous files such as generated files from install, build dependencies, or other kinds of temporary project files are removed from the PR.
  2. If applicable, update the README.md with any appropriate changes you've made.

Contact

  • Discord server
  • Discussions
  • Project leadership: /molotov/cherry/ (Discord)
    • Remove all forward slashes in names. They are there to prevent bots from harvesting names.