Skip to content

Commit

Permalink
Merge pull request #10399 from cBioPortal/update-contributor-docs
Browse files Browse the repository at this point in the history
Add some more info to getting started docs
  • Loading branch information
inodb authored Sep 22, 2023
2 parents 1b5539f + 6100424 commit 10f0d1c
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,16 @@ From the [GitHub Help Page of Using Pull Requests](https://help.github.com/artic

## Getting Started

### Programming
* Make sure you have a [GitHub account](https://github.com/signup/free).
* Create an issue in our issues tracker, assuming one does not already exist.
* Fork the cbioportal project on GitHub. For general instructions on forking a GitHub project, see [Forking a Repo](https://help.github.com/articles/fork-a-repo/) and [Syncing a fork](https://help.github.com/articles/syncing-a-fork/).
* Familiarize yourself with the [project documentation](https://docs.cbioportal.org), including the [Feature Development Guide](https://docs.cbioportal.org/4.-development/feature-development-guide), the [Architecture docs](https://docs.cbioportal.org/2.1-deployment/architecture-overview), the [backend code organization](docs/Backend-Code-Organization.md) and [backend development guidelines](docs/Backend-Development-Guidelines.md).
* Find a [good first issue](https://github.com/cBioPortal/cbioportal/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22) to start with
* Check if the issue will require frontend or backend changes. If it is for the frontend look at how to set up the [frontend repo](https://github.com/cbioPortal/cbioportal-frontend/) instead
* Fork the cbioportal or cbioportal-frontend project on GitHub depending on what your working on. For general instructions on forking a GitHub project, see [Forking a Repo](https://help.github.com/articles/fork-a-repo/) and [Syncing a fork](https://help.github.com/articles/syncing-a-fork/).
* Reach out on slack or our [Google user group](https://groups.google.com/g/cbioportal) if you run into any issues

### Documentation
If you'd like to improve our documentation, have a look at https://docs.cbioportal.org. At the bottom of each page is an "edit page" button to make changes. You can use the GitHub UI to edit the pages and submit them.

## Contributing Code Changes via a Pull Request

Expand Down

0 comments on commit 10f0d1c

Please sign in to comment.