Thank you for taking the time to contribute to this project 🎉
A contributor is anyone who suggests, creates, adds to, changes, updates, or reviews the material in this repository. Please refer to the Code of Conduct for information on what behaviours we expect of contributors.
This repository is here to help folks get started collaborating on the AIM-RSF projects. Its contents is being developed openly and invites contributions from anyone who wants to support the work of the AIM Consortium.
You can suggest topics to include in this repository, report mistakes/bugs, create Pull Requests that add resources, and help develop or review training materials. If there are resources you would like to add, please submit a Pull Request, or if you have questions about any of the information here, please open an Issue or start a Discussion.
To learn more about why we use a CONTRIBUTING.md file, please read the Contributors and Communication Pathways chapter in The Turing Way Guide for Project Design.
We have a Code of Conduct that applies to all the activities related to the AIM-RSF projects including the conduct expected of contributors to this repository and the many others in the AIM-RSF Organization.
That's what this repository is for! You can browse through the various resources and files to get familiar with the project, our tutorials, and other information about how to get started. There is also a great blog post about how to start contributing to projects on GitHub linked here.
Look through our currently open Issues to troubleshoot an issue, or look at the Discussions pages to participate in an ongoing discussion by commenting. You can also share this repository with one of your collaborators in the AIM Consortium who might be interested to get involved.
You can read our README file to find details and the next milestones in the project. You can also read different issues in this repository, comment where you would like to be involved, and link to other resources that may support our work. You can review the material and resources in this repository and offer updates by using a Pull Request. If you see an error or outdated information, open a GitHub Issue with and tag the original contributor
- For open tasks in this repository, please see the Issues section.
- Raise mistakes, errors or missing information on this repository by opening a Pull Request
- Read details on how to open a Pull Request
- Submit trivial fixes (for example, a typo, a broken link or an obvious error)
- Start work on a contribution that is already listed as an issue or something you’ve already discussed
- A Pull Request doesn’t have to represent finished work. It’s usually better to open a Pull Request early on, so others can watch or give feedback on your progress. Just mark it as a “WIP” (Work in Progress) in the subject line. You can always add more commits later.
This project is maintained by the members of the AIM Research Support Facility. For any organisation related queries or concerns, you can directly reach out to Sophia Batchelor by emailing sbatchelor@turing.ac.uk or Eirini Zormpa by emailing ezormpa@turing.ac.uk.
In this repository, we use the All Contributors Bot that help us recognise and acknowledge the work of our contributors. You can find all emoji/Type keywords representing the types of contribution.
To add a contributor, comment on Issue or Pull Request (where the contributor is involved) using this message for @all-contributors:
@all-contributors please add @<username> for <keyword in the Type column>
Many of the resources in this repository have been based of material in The Turing Way as part of the AIM-RSF's commitment to the practical integration of reproducibility practices and collaboration.
The work in this repository is licensed under the Creative Commons Attribution 4.0 International license for documentation and made public to our collaborators within the AIM consortium and the larger research community. You are free to share and adapt the material for any purpose, even commercially, as long as you provide attribution (give appropriate credit, provide a link to the license, and indicate if changes were made) in any reasonable manner, but not in any way that suggests the licensor endorses you or your use, and with no additional restrictions. Please note that this license does not extend to cover other materials or repositories in this organization unless directly specified.
For a more detailed contribution guideline, please check out The Turing Way's CONTRIBUTING.md file.