Skip to content
This repository has been archived by the owner on Jul 4, 2023. It is now read-only.

Latest commit

 

History

History
60 lines (38 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

60 lines (38 loc) · 2.14 KB

Contributing

Reporting issues & Request features

To report any issues and/or request new features, create a new GitHub issue.

Please make sure that you create one issue per topic you're addressing, following the reporting template provided in the GitHub issues section.

Source Code Changes

You are a team member/collaborator of this project

  1. Create a branch from master with a descriptive, kebab-cased name to hold all your changes.

  2. Modify the code and push your changes to your branch. Make sure that the triggered CI checks all pass.

  3. Once the changes are ready to be reviewed, create a GitHub pull request. With the pull request, provide a description of the changes and links to any relevant issues (in this repository or others).

  4. Ensure that the triggered CI checks all pass. These are triggered automatically with the results shown directly in the pull request.

  5. Once the checks pass, assign the pull request to the repository coordinator (who may then assign it to someone else).

  6. Interact with the reviewer to address any comments.

When the reviewer is happy with the pull request, he/she will "squash & merge" the pull request and delete the corresponding branch.

You are an external collaborator of this project

  1. Fork this repository and clone it.

  2. Checkout the branch you'll be modifying or adding to, and create you own branch out of that. Make sure this new branch name is descriptibe and kebab-cased.

  3. Commit and push your changes to your fork.

  4. Once the changes are ready to be reviewed, submit them upstream by creating a GitHub pull request. With the pull request, provide a description of the changes and links to any relevant issues (in this repository or others).

  5. Ensure that the triggered CI checks all pass. These are triggered automatically with the results shown directly in the pull request.

  6. Once the checks pass, assign the pull request to the repository coordinator (who may then assign it to someone else).

  7. Interact with the reviewer to address any comments.

When the reviewer is happy with the pull request, he/she will "squash & merge" the pull request.