You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.rst
+2-2
Original file line number
Diff line number
Diff line change
@@ -37,8 +37,8 @@ You want to make some kind of change to the code base
37
37
#. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest main commit. While working on your feature branch, make sure to stay up to date with the main branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions `here <https://help.github.com/articles/configuring-a-remote-for-a-fork/>`__ and `here <https://help.github.com/articles/syncing-a-fork/>`__);
38
38
#. make sure the existing tests still work by running ``python setup.py test``;
39
39
#. add your own tests (if necessary);
40
-
#. ensure the code is correctly linted (`ruff .`) and formatted (`ruff format .`);
41
-
#. see our `developer's readme <README.dev.md>`` for detailed information on our style conventions, etc.;
40
+
#. ensure the code is correctly linted (``ruff .``) and formatted (``ruff format .``);
41
+
#. see our `developer's readme <README.dev.md>`_ for detailed information on our style conventions, etc.;
42
42
#. update or expand the documentation;
43
43
#. `push <http://rogerdudler.github.io/git-guide/>`_ your feature branch to (your fork of) the DeepRank2 repository on GitHub;
44
44
#. create the pull request, e.g. following the instructions `here <https://help.github.com/articles/creating-a-pull-request/>`__.
Copy file name to clipboardExpand all lines: README.dev.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -79,7 +79,7 @@ During the development cycle, three main supporting branches are used:
79
79
80
80
## Making a release
81
81
82
-
1. Branch from `dev` and prepare the branch for the release (e.g., removing the unnecessary dev files such as the current one, fix minor bugs if necessary).
82
+
1. Branch from `dev` and prepare the branch for the release (e.g., removing the unnecessary dev files, fix minor bugs if necessary).
83
83
2.[Bump the version](https://github.com/DeepRank/deeprank2/blob/dev/README.dev.md#versioning).
84
84
3. Verify that the information in `CITATION.cff` is correct (update the release date), and that `.zenodo.json` contains equivalent data.
85
85
4. Merge the release branch into `main` (and `dev`), and [run the tests](https://github.com/DeepRank/deeprank2/blob/dev/README.dev.md#running-the-tests).
0 commit comments