Community Resources
Suport Page
A guide for users seeking assistance, reporting issues, or requesting features. This page outlines the primary channels for community support and details how to effectively engage with the project's support system through GitHub Discussions and Issues.
Click here for our templated support page
# Support
We take pride in our software and are passionate about helping others use them. If you are looking for help or collaboration, here is how you can get in touch.
## GitHub Discussions
Our primary platform for community support, feature requests, and general discussions is GitHub Discussions. This allows us to keep all conversations in one place and make them easily searchable for future reference.
### Getting Help
- [**Create a Support Discussion**](https://github.com/overture-stack/docs/discussions/categories/support)
- If you need assistance with Overture, please create a new discussion in our support category.
- Before creating a new discussion, please search existing discussions to see if your question has already been answered.
### Feature Requests
We love hearing your ideas for improving Overture! Before making a feature request, please check our current roadmap to see if your idea is already planned:
- [**Overture feature roadmap](https://github.com/orgs/overture-stack/projects/11/views/1)
If your idea isn't on the roadmap, feel free to create a new discussion in our Ideas category:
- [**Submit a Feature Request**](https://github.com/overture-stack/docs/discussions/categories/ideas)
## GitHub Issues
We use GitHub Issues primarily for tracking confirmed bugs and ticketing development tasks.
### Reporting Bugs
If you come across a potential bug or issue, please post it as a GitHub support discussion first:
- [**Report a Potential Bug**](https://github.com/overture-stack/docs/discussions/categories/support)
This allows us to confirm the issue and gather more information if needed. If we determine that further development is required, we will create a GitHub Issue from your discussion post.
## Staying Informed
### Release Announcements
- [**Release Announcements**](https://github.com/overture-stack/docs/discussions/categories/announcements)
- To stay up-to-date with the latest Overture releases and updates, keep an eye on our Announcements category in our GitHub Discussions.
## Community Guidelines
When participating in our community, please adhere to the following guidelines:
1. Be respectful and inclusive of all community members.
2. Provide as much relevant information as possible when asking for help.
3. Use clear and descriptive titles for your discussions and issues.
4. Search existing discussions before creating a new one to avoid duplicates.
5. Follow the GitHub Community Guidelines and abide by our [code of conduct](https://docs.overture.bio/community/code-of-conduct).
Team Page
A showcase of the project's core team members, contributors, and acknowledgments. This page helps users connect with the people behind the project and recognizes those who have made significant contributions to its development.
Click here for our templated support page
## Team Page
<details>
<summary>**Click here for our templated team page**</summary>
# Team
[Introduce your team, your expertise and your mission]
## Authors
<div class="row">
<div class="col col--4 margin-bottom--lg margin-bottom--md">
<div class="card__header">
<div class="avatar avatar--vertical">
<a href="https://github.com/user">
<img
class="avatar__photo avatar__photo--xl margin-bottom--md"
src="https://github.com/user.png"
/>
</a>
<div class="avatar__intro">
<h3 class="avatar__name">Team Memeber</h3>
</div>
</div>
</div>
</div>
## Honorary Mentions
- **Name**: [Acknowledgement]
- **Name**: [Acknowledgement]
- **Name**: [Acknowledgement]
- **Name**: [Acknowledgement]
Funding Page
A transparent overview of the financial support and organizations that make the project possible. This page acknowledges funding sources, grants, and additional support while providing information about project sustainability and institutional backing.
Click here for our templated funding page
# Funding
We gratefully acknowledge the financial support that has made this project possible. Our work has been funded by the following organizations and grants:
### [Funding Source]
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
- Grant Number: [#U24CA253529]
- Project Title: "Project Title"
- Funding Period: [YYYY-YYYY]
### [Funding Source]
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
- Grant Number: [XXX-XXXX]
- Project Title: "Project Title"
- Funding Period: [YYYY-YYYY]
### [Funding Source]
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
- Grant Number: [XXX-XXXX]
- Project Title: "Project Title"
- Funding Period: [YYYY-YYYY]
## Additional Support
We also thank the following organizations for their contributions:
- [Supporting Organization 1] - [Type of Support]
- [Supporting Organization 2] - [Type of Support]
- [Supporting Organization 3] - [Type of Support]
For more information about our funding or to discuss potential collaborations, please email us at contact@overture.bio.
**Last updated:** mm-dd-yy
Code of Conduct Page
A clear set of guidelines establishing community behavior standards and expectations. This document ensures a respectful, inclusive, and harassment-free environment for all community members while outlining enforcement procedures for maintaining these standards.
Click here for our code of conduct page
# Code of Conduct
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, caste, color, religion, or sexual
identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[this email](contact@overture.bio).
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of
actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the
community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].
[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
Contribution Page
A detailed guide for potential contributors, outlining how to participate in the project's development. This page provides step-by-step instructions for submitting code changes, best practices for pull requests, and explains the development workflow to help new contributors get started effectively.
Click here for our code of conduct page
---
sidebar_label: Contribution
---
# Contributing to Overture
We appreciate your interest in contributing to the Overture project. We are the Genome Informatics Software Engineering team from Ontario Institute for Cancer Research. At OICR we develop new software, databases and other necessary components to store, organize and compute over the large and complex datasets being generated by our cancer research programs. Embodying OICR's values of collaboration and community, we are firm believers in open-source and open-science. As such we strongly believe in the collective power of expertise and shared resources.
## Code of Conduct
By participating in this project, you are expected to abide by our [Code of Conduct](https://docs.overture.bio/community/code-of-conduct). Please take the time to read it carefully before contributing.
## Get Involved
**Getting Started:** Our primary platform for community support, feature requests, and general discussions is GitHub Discussions. This allows us to keep all conversations in one place and make them easily searchable for future reference.
**Community Support:** Our primary platform for community support, feature requests, and general discussions is [GitHub Discussions](https://github.com/overture-stack/docs/discussions). This allows us to keep all conversations in one place and make them easily searchable for future reference.
- **Getting Help:** If you need assistance with Overture, please create a [new discussion in our support category](https://github.com/overture-stack/docs/discussions/categories/support).
- Before creating a new discussion, please search existing discussions to see if your question has already been answered.
- **Feature Requests & Proposals:** We love hearing your ideas for improving Overture! Before making a feature request, please check our [**feature roadmap**](https://github.com/orgs/overture-stack/projects/11/views/1) to see if your idea is already planned.
- If your idea isn't on the roadmap, feel free to [**submit a feature request**](https://github.com/overture-stack/docs/discussions/categories/ideas) by creating a new discussion in our Ideas category
- **Report a Potential Bug:** We use GitHub Issues primarily for tracking confirmed bugs and ticketing development tasks. If you come across a potential bug or issue, please first post it to our [**GitHub support discussion forum**](https://github.com/overture-stack/docs/discussions/categories/support).
- This allows us to confirm the issue and gather more information if needed. If we determine that further development is required, we will create and tag you into a GitHub Issue from your discussion post.
## Our Development Process
We use GitHub issues and pull requests for communication related to code changes.
### Branch Organization
We use the following standard branches:
- `main` is for stable production code
- `develop` is the integration branch for new features
- `feature/<name>` for feature branches
- `release/v<version>` for release branches
- `hotfix/<name>` for hotfix branches
## Pull Requests
### Submitting a Pull Request
We welcome and encourage pull requests from the community. To submit a pull request, please follow these steps:
1. **Fork the Repository**: Fork the Overture repository on GitHub.
2. **Clone Your Fork**: Clone your forked repository to your local machine.
3. **Create a New Branch**: Create a new branch for your changes. Use lowercase and hyphens (e.g., `feature/user-authentication`). Include ticket/issue numbers when applicable (e.g., `feature/PROJ-123-user-authentication`).
4. **Make Your Changes**: Implement your changes and commit them to your branch. Write clear, concise commit messages in present tense (e.g., "Add feature" not "Added feature"). Reference issue numbers in commits when applicable.
5. **Push Your Changes**: Push your changes to your forked repository.
6. **Submit a Pull Request**: Open a pull request against the main repository.
### Best Practices
1. **Keep PRs as small as possible:** Focus on one feature or bug fix per pull request. Break large changes into smaller, more manageable pieces making it easier for reviewers to understand and approve your changes.
2. **Use descriptive titles:** Start with a verb (e.g., "Add", "Fix", "Update", "Refactor"), briefly summarize the main purpose of the PR and include the issue number if applicable (e.g., "Fix user authentication bug (#123)").
3. **Describe how you tested it:** Explain the testing process you followed and mention any new automated tests you've added.
4. **Provide a clear description:** Explain the purpose of your changes and list the main modifications you've made. Mention any potential side effects or areas that might need extra attention.
5. **Link related issues:** Reference any related issues or pull requests. Use GitHub keywords to automatically link issues (e.g., "Closes #123", "Fixes #456").
6. **Keep the PR's branch up-to-date:** Regularly rebase your branch on the latest main branch and resolve any merge conflicts promptly.
7. **Respond to feedback:** Be open to suggestions and willing to make changes. Address all comments from reviewers. If you disagree with a suggestion, explain your reasoning politely.
8. **Include documentation updates:** If your changes affect user-facing features, update or create and issue detailing the relevant changes need to the documentation. Where appropriate include inline comments for complex code sections.
10. **Be patient:** Reviewers will likely be unable to respond immediately. However, feel free to follow up politely if you haven't received feedback after a reasonable time.
### Using Draft Pull Requests
Draft Pull Requests are an excellent way to document work in progress and facilitate early feedback. Use them to:
- Organize your thoughts and process
- Share early work and ideas with the team
- Get feedback on implementation approaches before finalizing code
- Track progress on long-running features
Guidelines for Draft Pull Requests:
1. **Creation**:
- Open a pull request and select "Create draft pull request"
- Clearly mark the title with [WIP] or [DRAFT] prefix
2. **Description**:
- Outline the current state of the work
- List planned tasks or improvements
- Highlight areas where feedback is specifically needed
3. **Updates**:
- Regularly update the description or provide comments following commits with progress notes
- Use task lists (using `- [ ]` in Markdown) to track completion of sub-tasks
4. **Collaboration**:
- Encourage early feedback and discussion
- Use the pull request comments for design discussions
5. **Finalization**:
- Complete all planned work and address feedback
- Update tests and documentation
- Click "Ready for review" to move out of draft state
### Merging a Pull Request
- Ensure all CI checks pass
- Obtain the required number of approvals
- Use the project's specified merge strategy (Typically squash and merge)
- Delete the source branch after merging if no longer needed