Contributing¶
Thank you for contributing to the Automation in Biology community repository.
Research-output submissions¶
Do not submit research files through a pull request.
Use the GitHub submission issue form after submitting the corresponding record to the Automation in Biology community on Zenodo.
To start a submission, open:
https://github.com/rotsl/biologyautomation/issues/new?template=submission.yml
Documentation contributions¶
Pull requests are welcome for:
- Corrections
- Improvements to submission guidance
- New examples
- Accessibility improvements
- Translation proposals
- Workflow improvements
- Curation-policy clarifications
- Security improvements
Pull-request process¶
- Fork the repository.
- Create a focused branch.
- Make the proposed change.
- Review spelling, links, and formatting.
- Run or check the repository validation workflow.
- Open a pull request.
- Explain the purpose of the change.
- Address maintainer feedback.
Suggested branch names¶
Examples:
docs/improve-submission-guidedocs/fix-community-linkworkflow/improve-validationpolicy/clarify-dataset-requirements
Commit messages¶
Use short, specific commit messages.
Examples:
docs: clarify software submission requirementsfix: correct Zenodo community linkci: validate issue form YAMLpolicy: add conflict-of-interest guidance
Prohibited content¶
Do not include:
- API keys
- Passwords
- Private access tokens
- Confidential information
- Restricted research files
- Unlawfully shared personal data
- Malware
- Files that you are not authorised to distribute
Research files¶
Research outputs belong on Zenodo or another appropriate research repository, not in this GitHub repository.
Conduct¶
Participation is governed by the repository Code of Conduct.