Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

34 lines (28 loc) · 1.9 KB

Contributing to AIS

Code of Conduct

By participating in this project, you agree to uphold the (Code of Conduct)[ais/.github/CODE_OF_CONDUCT.md]

Pull Request (PR) Workflow

  1. Read the pull request merge checklist and plan your work around it.
  2. Find an issue to work on and assign yourself to it. If an issue does not exist for what you want to work on, create the issue first.
  3. Push your (unfinished) work early so others can see it. You need to create a branch in the following style: <name>/<type>/<description>, where <name> is your own surname, <type> is one of: feat for feature, hot for (hot)fix, doc for documentation, chore for chores, or refactor for refactor. E.g. adam/feat/add-fair-button-in-profile for a PR that adds a fair button in the profile page.
  4. Right away, open a PR on GitHub based on that branch. Assign yourself to the PR, and add a "draft" label to the PR if you don't think it's ready to be merged. Insert the below checklist as the first comment on your PR. The title and description of the PR will be used for the final merge commit title and body, respectively. These can edited while developing your PR. Link your pull request to the issue(s) that it will resolve.
  5. If you think the PR is ready to be merged and have handled all checklist items, remove the "draft" label (if present) and ask for a review. The PR reviewer(s) should double check that all checklist items are taken care of before merging the PR. Failing to follow the checklist could lead to not meeting our project requirements.

Pull Request Merge Checklist

  • Feature/fix PRs should add one atomic (as small as possible) feature or fix.
  • The code compiles and all the tests pass.