From 45ee5b5846eb4e1191228fce0dbad72eac7696a4 Mon Sep 17 00:00:00 2001 From: Chris Bridge Date: Sun, 26 Nov 2023 21:28:17 -0500 Subject: [PATCH] Add gitflow section to the developer guide --- docs/development.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/development.rst b/docs/development.rst index a99c624e..4364c738 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -21,10 +21,17 @@ The :mod:`highdicom` package can be installed in *develop* mode for local develo Pull requests ------------- -Don't commit code changes to the ``master`` branch. New features should be implemented in a separate branch called ``feature/*`` and bug fixes should be applied in separate branch called ``bugfix/*``. +We encourage contributions from the users of the library (provided that they fit within the scope of the project). +If you are planning to make a contribution to the library, we encourage you to leave an issue first on the `issue tracker `_ detailing your proposed contribution. +This way, the maintainers can vet your proposal, make sure it is within the scope of the project, and guide you through the process of creating a successful pull request. Before creating a pull request on Github, read the coding style guideline, run the tests and check PEP8 compliance. +We follow a `gitflow `_-like process for development. +Therefore, please do not commit code changes to the ``master`` branch. +New features should be implemented in a separate branch called ``feature/*``, and a pull request should be created with the target set as the development branch with the name of the *next* release (e.g. ``v0.22.0dev``). +Bug fixes that do not affect the public API of the project should be applied in separate branch called ``bugfix/*`` and a pull request should be created with targeted at ``master`` branch. + .. _coding-style: Coding style