Contributing to the handbook
Welcome, and thank you for your interest in contributing to the Bioconductor All-Community Handbook!
Everyone is welcome to help shape the Bioconductor All-Community Handbook. Whether you are new to Bioconductor or have been involved for years, your experience and perspective can help make this resource more useful and accessible.
Contributions of all sizes are appreciated: fixing a typo, clarifying an explanation, sharing a resource, or suggesting a new topic. You do not need to be an expert in GitHub or write a finished chapter to get involved. Our ambition is to author this book as a community, drawing on our shared knowledge and diverse experiences.
The two main ways to contribute are to discuss ideas through GitHub issues and propose changes through pull requests.
Please follow our Code of Conduct in all interactions.
Proposing a change
The handbook is maintained in a GitHub repository. Changes are proposed through pull requests, which let others read and discuss your edits before they become part of the handbook.
- Fork the repository. A fork is your own copy of the repository on GitHub, where you can make changes freely.
- Make your edits on a new branch. A branch keeps a set of related changes together. Edit the relevant files in your fork, either on GitHub or on your computer, and commit your changes with a short description.
- Open a pull request. Propose merging your branch into the original repository’s
mainbranch. Give the pull request a descriptive title and use the description field to briefly explain what you changed and why. If you would like early feedback, open a draft pull request and mention where you would like help.
Discussing contributions
You are welcome to open an issue directly on the book’s repository to discuss content you plan to add, suggest a change, flag a problem, or ask for help. For larger additions, sharing your ideas early can help you explore the scope and find others interested in contributing.
You can also reach out through the channels listed in Community channels to gather ideas, ask questions, or find collaborators. You do not need a finished proposal to start a conversation.
Review and inclusion
Review is intended to be light-touch and collaborative. Contributions are reviewed for clarity, relevance, and consistency with the rest of the handbook. Clarifying questions may be asked and small edits may be requested. Feedback is a conversation: you are welcome to ask for clarification or help, and further commits to your branch will update the pull request automatically.
Once the contribution is ready and approved, a maintainer can merge it into the handbook.
Credits
We want to recognize the people who help create and maintain this handbook. After contributing, please add your name and details to the contributors list, following its alphabetical order and entry format. You can include links such as your GitHub profile or ORCID iD, and indicate your contribution role(s), such as creation, content, or maintenance. You can add your entry in the same pull request as your contribution, or submit it separately.
Contributing to The Turing Way links to useful resources on collaborating through GitHub and writing in Markdown, which can also help you contribute to this handbook.