Skip to content

Commit a3278a0

Browse files
kopporsubhramit
andauthored
Refine CONTRIBUTING.md (#12742)
Co-authored-by: Subhramit Basu <[email protected]>
1 parent 3d22e2c commit a3278a0

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

CONTRIBUTING.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -159,21 +159,24 @@ We reserve the right to reject pull requests that contain little or no genuine a
159159

160160
### After submission of a pull request
161161

162-
After you submitted a pull request, automated checks will run.
163-
You may see "Some checks were not successful".
164-
You can click on failing checks to see more information about why they failed.
165-
Then, please look into them and handle accordingly.
162+
Once you submit a pull request, automated checks will run and bots will perform a preliminary review on your code.
163+
You will get automated comments on your pull request within about 5 minutes.
164+
Acting on them in a timely manner is expected.
166165

167-
Afterwards, you will receive comments on your pull request.
168-
Since JabRef is driven by volunteers in their spare time, reviews may take more time than a project with full time developers.
169-
The pull request may be approved immediatly, or a reviewer may request changes.
170-
In that case, please implement the requested changes.
166+
You may also see "Some checks were not successful".
167+
You can click on failing checks to see more information about why they failed.
168+
Please look into them and handle accordingly.
171169

172170
After implementing changes, commit to the branch your pull request is *from* and push.
173171
The pull request will automatically be updated with your changes.
174172
To maintain a clean git history, your commits will also be automatically squashed upon acceptance of the pull request, during merging.
175173
Thus, no need to worry about WIP commits or [fixing git submodule issues](https://devdocs.jabref.org/code-howtos/faq.html#submodules), and force-pushing should be **avoided**.
176174

175+
After all the basic checks are green, maintainers will look at your pull request.
176+
Since JabRef is driven by volunteers in their spare time, reviews may take more time than a project with full time developers.
177+
The pull request may be approved immediatly, or a reviewer may request changes and/or have discussions regarding your approach.
178+
In that case, you are expected to answer any questions and implement the requested changes.
179+
177180
Please – **never ever close a pull request and open a new one** -
178181
This causes unessesary work on our side, and is not in the the style of the GitHub Open Source community.
179182
You can push any changes you need to make to the branch your pull request is *from*.

0 commit comments

Comments
 (0)