From afc7428e48d154be5308142aeaebea561c11290b Mon Sep 17 00:00:00 2001 From: Jeff Rhoades <37990507+rhoadesScholar@users.noreply.github.com> Date: Thu, 9 May 2024 11:42:01 -0400 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 892c7333a..48a13b95a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,10 +22,10 @@ This will also be run automatically when a PR is made to master and a codecov re ## Branching and PRs -- Users that have been added to the CellMap organization and the DaCapo project should be able to develop directly into the CellMap fork of DaCapo. Other users will need to create a fork. -- For a completely new feature, make a branch off of the `dev/main` branch of CellMap's fork of DaCapo with a name describing the feature. If you are collaborating on a feature that already has a branch, you can branch off that feature branch. -- Currently, you should make your PRs into the `dev/main` branch of CellMap's fork, or the feature branch you branched off of. PRs currently require one maintainer's approval before merging. Once the PR is merged, the feature branch should be deleted. -- `dev/main` will be regularly merged to `main` when new features are fully implemented and all tests are passing. +- Users that have been added to the CellMap organization and the DaCapo project should be able to develop directly into the CellMap fork of DaCapo. Other users will need to create a fork or ask to be added as a collaborator. +- For a completely new feature, make a branch off of the `main` branch of CellMap's fork of DaCapo with a name describing the feature. If you are collaborating on a feature that already has a branch, you can branch off that feature branch. +- Currently, you should make your PRs into the `main` branch of CellMap's fork, or the feature branch you branched off of. PRs currently require one maintainer's approval before merging. Once the PR is merged, the feature branch will/should be deleted. +- `main` will be regularly published to PyPi when new features are fully implemented and all tests are passing. ## Documentation @@ -33,4 +33,4 @@ Documentation is built using Sphinx. To build the documentation locally, run ```bash sphinx-build -M html docs/source docs/build ``` -This will generate the html files in the `docs/build/html` directory. \ No newline at end of file +This will generate the html files in the `docs/build/html` directory.