diff --git a/docs/posts/contribute.md b/docs/posts/contribute.md index 02b71f13..e9de7617 100644 --- a/docs/posts/contribute.md +++ b/docs/posts/contribute.md @@ -1,4 +1,5 @@ # Code of conduct + We warmly welcome contributions from the community! To ensure a welcoming experience for our entire community, this project adheres to the Contributor Covenant @@ -13,12 +14,16 @@ If you have any questions about any of this stuff, just ask! :) We'd love to hear from you! Please submit any bug reports and feature requests through [Github issues](https://github.com/chanzuckerberg/cellxgene/issues). # Direct contributions + ## Getting started -If you are interested in working on `cellxgene` development, you'll need to use git to make a copy of the [project repository](https://www.youtube.com/watch?v=A-4WltCTVms&list=PLe6EXFvnTV7-_41SpakZoTIYCgX4aMTdU&index=2&t=0s) and share your changes. -If you're new to git, we recommend [GitKraken](https://www.gitkraken.com/) for an intuitive interface. +If you are interested in working on `cellxgene` development, you'll need to use git to make a copy of the [project repository](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks) and share your changes. -Please submit any direct contributions by [forking the repository](https://www.youtube.com/watch?v=Lb4yvfrX_7I&list=PLe6EXFvnTV7-_41SpakZoTIYCgX4aMTdU&index=3&t=9s), creating a branch, and [submitting a Pull Request](https://www.youtube.com/watch?v=2VX1ISk9XH8&list=PLe6EXFvnTV7-_41SpakZoTIYCgX4aMTdU&index=9&t=0s). +We have several "rules" (strong suggestions really) for contributions: + +1. If your contribution is complex, adds new features, new UI design or otherwise warrants discussion, we highly recommend that you submit a github issue, and engage other contributors in a discussion about the details of your proposed PR. This will save you time in the long run, as many details and decisions can be hashed out ahead-of-time. + +2. Please submit any direct contributions by [forking the repository](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks), creating a feature branch, and [submitting a Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). First, you'll need the following installed on your machine @@ -33,13 +38,13 @@ git clone https://github.com/chanzuckerberg/cellxgene.git This is enough to get you started with editing documentation. If you'd like to contribute code: -Build the client web assets by calling `make` from inside the `cellxgene` folder +Build the client web assets from inside the `cellxgene` folder ``` -make +make build-for-server-dev ``` -Install all requirements (we recommend doing this inside a [virtual environment](install)) +Install all requirements (we recommend doing this inside a [virtual environment](https://docs.python.org/3/tutorial/venv.html)) ``` pip install -e .