Skip to content

Commit 2c273ae

Browse files
committed
docs: updated instructions
1 parent b0ecd63 commit 2c273ae

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

.github/CONTRIBUTING.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11

22
# Contribution Guidelines for DIRAC
33

4-
54
## Pull Requests
65

76
When making a `Pull Request` please explain what and why things were
@@ -12,7 +11,7 @@ relase.notes, once a new tag is made.
1211
Please prepend the title of your pull request with `[targetReleaseBranch]`.
1312

1413
We are happy if you create pull-requests also if you feature is not ready, yet.
15-
Please mark them as such by adding `[WIP]` to the start of the title. The purpose
14+
Please mark them as drafts in this case. The purpose
1615
of this is, for example, that you want to let other people know you are working
1716
on a given issue. For these work-in-progress pull-request, we propose to have a
1817
check list of things that still need to be done.
@@ -24,9 +23,13 @@ If you notice an issue, consider first creating an issue and then refering to it
2423
in your pull-request and commit messages with `#[issue-id]`.
2524

2625
## Coding Conventions
27-
* You should follow the [DIRAC Coding Conventions](https://dirac.readthedocs.io/en/latest/DeveloperGuide/CodingConvention/index.html)
28-
* Your code should not introduce any new pylint warnings, and fix as many existing warnings as possible
26+
27+
* You should follow the [DIRAC Coding Conventions](https://dirac.readthedocs.io/en/latest/DeveloperGuide/CodingConvention/index.html)
28+
* Your code should not introduce any new pylint warnings, and fix as many existing warnings as possible
2929

3030
## Git workflow
3131

32-
The DIRAC Development Model is described in the [documentation](https://dirac.readthedocs.io/en/latest/DeveloperGuide/DevelopmentModel/index.html) with detailed instructions on the git workflow listed [here](https://dirac.readthedocs.io/en/latest/DeveloperGuide/DevelopmentModel/ContributingCode/index.html). For additional help on the git(hub) workflow please see this [tutorial](https://github.com/andresailer/tutorial#working-updating-pushing).
32+
The DIRAC Development Model is described in the [documentation](https://dirac.readthedocs.io/en/latest/DeveloperGuide/DevelopmentModel/index.html) with detailed instructions on the git workflow listed [here](https://dirac.readthedocs.io/en/latest/DeveloperGuide/DevelopmentModel/ContributingCode/index.html). For additional help on the git(hub) workflow please see this [tutorial](https://github.com/andresailer/tutorial#working-updating-pushing).
33+
34+
Open a pull request only for the target branch. The [PR Sweeper](https://github.com/DIRACGrid/pr-sweeper) will (try to) create a PR for the "upper" branches.
35+
If failing to do so, an issue will be created and assigned to the PR opener.

0 commit comments

Comments
 (0)