This template and our recommendation pages were made by research software engineers at UCL's Centre for Advanced Research Computing. We made it with research software projects in mind, but whoever you are, we hope you find this useful!
We are actively encouraging users to ask questions and start discussions in the discussions tab of this repository. Does something seem like it's broken? Please go ahead and open an issue!
The website pages are open to contributions but they will need to be reviewed by a member or associate member of ARC. We might be slow to approve new tool suggestions (since we'll probably want to discuss them first) but don't let that put you off creating an issue.
To contribute a change, please:
- Create a new branch (or fork if you're not in @UCL-ARC/collaborations).
- Modify an existing page, create a new one, or tweak the template. a. Run
pre-commit which will lint your changes. b. Check
the tests pass if you modified the template (
pytest -s). - Open a pull request (PR) with changes.
- Ask someone who did not contribute to the PR from @UCL-ARC/collaborations to review it.
- If approved with no comments, then the reviewer will merge the PR.
- If changes are requested, the PR author should address the comments, and then ask for review again.