Skip to content

Latest commit

 

History

History
54 lines (31 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

54 lines (31 loc) · 3.06 KB
Raw

How do I contribute?

👍🎉 First off, thanks for taking the time to read this and contribute! 🎉👍

Open Targets follows the usual open-source project conventions for external contributions. Here is a quick rundown:

  1. Find an issue you are interested in addressing. Consider posting in the issue to inform us about your work.

  2. Fork the relevant repository to your GitHub account. The Development section of the readme provides more information on how to start the development environment.

  3. Create a new branch for your work using git checkout -b branch-name-here.

  4. Work on your contribution. To stay on course with our best practices, be sure to read the guidelines.

  5. open a pull request (PR) when you are done. Follow the PR template to match our PR structure.

  6. Wait for the pull request to be reviewed by a maintainer.

  7. Make changes to the pull request if the reviewing maintainer recommends them.

  8. Celebrate your success after your pull request is merged!

General guidelines for contributing

  1. A PR must address a single issue or feature.
  2. There must always be an issue number associated with the PR (in the title or description).
  3. The branch should be rebased on main before opening the PR.
  4. No changes to code not directly related to your PR.
  5. Includes documentation.

* This limitation is enforced on most PRs. A large feature or an issue that pertains to different logical units can have more than one commit, but the general rule is one issue per PR, one commit per PR.

I have questions!

If you have any questions about contributing to Open Targets Platform you can head to our Community, or post in the issue tracker repo.

Try to ask your question so it's as easy to answer as possible. If you're not sure how to do that, these are some excellent guides:

What does the Code of Conduct mean for me?

Our Code of Conduct means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity. If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do our best to ensure that the abuser is reprimanded appropriately, per our code.

Acknowledgements

This contributor guidelines document is based on the following: