The following is a set of guidelines for contributing to AcidWatch.
We use prettier as our code formatter. Format all of your code prior to commiting. There is a GitHub workflow with the check that must be successful in order for you to be able to merge a pull request to main branch.
We strive to keep a consistent and clean git history in the main branch and all contributions should adhere to the following:
- The commit message should be descriptive.
- Ideally, a commit should do one atomic change on the repository.
- All the changes should be accounted for and not go "implicitly".
We expect commit messages to follow this style:
- Separate subject from body with a blank line
- Keep the subject line short and informative
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Use the body to explain what and why instead of how
This list is inspired by here.
Every commit in the main branch should be added through a pull request.
Ideally a pull request will be small in scope and atomic.
If you are fixing a minor detail in addition to the scope of your PR (formatting, linting, moving, simple refactoring ...), please make sure that this results in a separate commit.
If you find that you want to do lots of changes that are not directly related to the issue you're working on, create a separate PR.