Skip to content

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

  1. Fork the repository.
  2. Create a focused branch.
  3. Make the proposed change.
  4. Review spelling, links, and formatting.
  5. Run or check the repository validation workflow.
  6. Open a pull request.
  7. Explain the purpose of the change.
  8. Address maintainer feedback.

Suggested branch names

Examples:

  • docs/improve-submission-guide
  • docs/fix-community-link
  • workflow/improve-validation
  • policy/clarify-dataset-requirements

Commit messages

Use short, specific commit messages.

Examples:

  • docs: clarify software submission requirements
  • fix: correct Zenodo community link
  • ci: validate issue form YAML
  • policy: 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.