Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removing develop branch from docs #198

Merged
merged 1 commit into from
Dec 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions PUBLISHING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,9 @@ Maintainers should reach consensus before going ahead with publishing changes.
Note that the publishing to PyPI step below will require credentials
that are only made available to core maintainers of TRTools.

We use a simplified version of
`git flow <http://web.archive.org/web/20200520162709/https://nvie.com/posts/a-successful-git-branching-model/>`_
to maintain and publish trtools.
We use the master branch as the default branch with the latest stable codebase.
Note that we use the master branch as the default branch with the latest stable codebase.
The builds from this branch are distributed to PyPI and conda.
The develop branch contains new features that have yet to make their way into master.
Other branches are used for development.

New Dependencies
----------------
Expand All @@ -31,13 +28,14 @@ If you've added dependencies to trtools or its tests, those dependencies should
Publishing Steps
----------------

Once changes have been made to develop that are ready to be published, first choose the new version number according to `semantic versioning <https://semver.org>`_. Then set up the environment you're going to publish TRTools from:
Once changes have been made to a branch that are ready to be published, first choose the new version number according to `semantic versioning <https://semver.org>`_.
Then set up the environment you're going to publish TRTools from:

#. Create a clean environment.
#. Install setuptools with version >= 40.8.0
#. Additionally, install ``pytest``, ``wheel``, ``build``, and ``twine``
#. Clone the `trtools repo <https://github.com/gymrek-lab/TRTools>`_
#. Check out the develop branch
#. Check out the branch with the new work
#. Run :code:`pip install --upgrade pip && pip install -e .`

Then go through the steps of merging the changes into the master branch:
Expand All @@ -46,7 +44,7 @@ Then go through the steps of merging the changes into the master branch:
#. Update the version number listed in the :code:`pyproject.toml` file.
#. Change the 'Unreleased Changes' section of :code:`RELEASE_NOTES.rst` to the new version number.
#. Check if any changes have been made that have not yet been documented in the release notes. If so, document them.
#. Submit a pull request from develop into master on the github website.
#. Submit a pull request from this branch into master on the github website.
#. If the code review checks pass, merge the pull request.
#. Tag the merge commit with the package version in vX.Y.Z format. (For more details on tagging, see `below`)

Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ We appreciate contributions to TRTools. If you would like to contribute a fix or
#. Install TRTools from source `as above <From source_>`_.
#. Additionally, install :code:`pytest`, `pytest-cov <https://anaconda.org/conda-forge/pytest-cov>`_, :code:`sphinx>=3` and :code:`sphinx_rtd_theme`, in your environment.
#. Fork the TRTools repository.
#. The :code:`develop` branch contains the latest pre-release codebase. Create a branch off of :code:`develop` titled with the name of your feature.
#. Create a branch off of :code:`master` titled with the name of your feature.
#. Make your changes.
#. Document your changes.

Expand All @@ -163,7 +163,7 @@ We appreciate contributions to TRTools. If you would like to contribute a fix or

* :code:`cd` to the root of the project and run :code:`python -m pytest --cov=. --cov-report term-missing` to make sure that (1) all tests pass and (2) any code you have added is covered by tests. (Code coverage may **not** go down).

#. Submit a pull request **to the develop branch** of the central repository with a description of what changes you have made.
#. Submit a pull request to the master branch of the central repository with a description of what changes you have made.
A member of the TRTools team will reply and continue the contribution process from there, possibly asking for additional information/effort on your part.

Publishing
Expand Down
Loading