|
| 1 | +# Contributing Guide |
| 2 | + |
| 3 | +This repository is a collection of best practices and coding standards. It has been made by [research |
| 4 | +software engineers] at [UCL's Centre for Advanced Research Computing][UCL ARC]. |
| 5 | +Some of it is from our internal documentation and recommendations pulled out and made public. |
| 6 | +The content is stored in [GitHub flavoured markdown], and is rendered as a live [webpage]. |
| 7 | + |
| 8 | +Any changes should be reviewed by a member or associate member of ARC. |
| 9 | +If the additions are taken from ARC's internal documentation, **please add the original author** as a reviewer to check that they're OK with their content being made public a CC-by-4.0. |
| 10 | +If something seems like it's broken, please go ahead and [open an issue]! |
| 11 | + |
| 12 | +> [!NOTE] |
| 13 | +> We're open for contributions from anyone but it's the UCL ARC recommended best-practices, so ulitmately it belongs to the software teams at ARC and we may not adopt suggestions from outside (sorry!). |
| 14 | +
|
| 15 | +## Development workflow |
| 16 | + |
| 17 | +To contribute a change, please: |
| 18 | + |
| 19 | +1. Create a new branch (or fork if you're not in [@UCL-ARC/collaborations]). |
| 20 | +2. Modify an existing page, or create a new one. |
| 21 | + a. Run [pre-commit] which will lint your changes. |
| 22 | +3. Open a _pull request_ (PR) with changes. |
| 23 | +4. Ask someone who did not contribute to the PR from [@UCL-ARC/collaborations] |
| 24 | + to review it. |
| 25 | +5. If approved with no comments, then the last approving reviewer should merge the PR. |
| 26 | +6. If changes are requested, the PR author should address the comments, and then |
| 27 | + ask for review again. |
| 28 | + |
| 29 | +<!-- links here --> |
| 30 | + |
| 31 | +<!-- prettier-ignore-start --> |
| 32 | + |
| 33 | +[GitHub flavoured markdown]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax |
| 34 | +[webpage]: http://github-pages.arc.ucl.ac.uk/coding-standards/ |
| 35 | +[UCL ARC]: https://ucl.ac.uk/arc |
| 36 | +[open an issue]: https://github.com/UCL-ARC/coding-standards/issues/new/choose |
| 37 | +[Research software engineers]: https://society-rse.org/about/history |
| 38 | +[pre-commit]: https://pre-commit.com |
| 39 | +[@UCL-ARC/collaborations]: https://github.com/orgs/UCL-ARC/teams/collaborations |
| 40 | + |
| 41 | +<!-- prettier-ignore-end --> |
0 commit comments