Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: ElliottKasoar <[email protected]>
  • Loading branch information
alinelena and ElliottKasoar authored Aug 8, 2024
1 parent 4e5fb81 commit 332a2d6
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,28 +35,30 @@ include,
- Bug: anything in this is critical and shall be fixed asap.
- Design: queries or suggestions about the structure of the program.
- Enhancement: for issues relating to new features.
- Documentation: adding or enhancing documentation

## Review

All merge requests will be reviewed to ensure the integrity of the code.

The reviewer/s have the following responsibilities,
The reviewer(s) have the following responsibilities:

- Ensuring all contribution rules have been followed
- Ensuring the [coding style](./coding_style.md) is adhered to
- Only accepting a merge if all tests have passed
- Using the comments system to request changes for the submittor to make

### Enforcing style

github actions will automatically run precommit and enforce the style.
To reduce the number of failures in CI please run pre-commit locally before
you push to the repo
GitHub Actions will automatically run a pre-commit and enforce the coding style.
To reduce the number of CI failures, please run the pre-commit locally before
you push to your repository.

```sh
pre-commit run --all-files
```

## Using the git for development
## Using git for development

The Github instance hosts an *upstream* repository, which we will refer to
as *upstream*. Contributors will work on their own personal copies of the
Expand Down

0 comments on commit 332a2d6

Please sign in to comment.