s434730/RandomSec
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update contributing.md (#4275)

Browse Source 
* Update contributing.md

* Update contributing.md

updated as per comments about "closes" and "fixes" special words

* update contributing.md as per suggestions

Co-authored-by: Antonin Delpeuch <antonin@delpeuch.eu>

Co-authored-by: Antonin Delpeuch <antonin@delpeuch.eu>
This commit is contained in:
Moeti-Mphoso 2021-11-07 15:52:04 +02:00 committed by GitHub
parent 08bc7949fc
commit f096c35234
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/technical-reference/contributing.md
View File

@ -61,7 +61,7 @@ This describes the overall steps to your first code contribution in OpenRefine.
- Make changes to the code to fix the issue. If you are changing backend code, it would be great if you could also write a test in Java to demonstrate the fix. You can imitate existing tests for that. We currently do not have frontend tests.
- commit your changes, using a message that contains "closes #1234" or "fixes #1234", this will link the commit to the issue you are working on.
- commit your changes, using a message that contains one of the special words "closes" and "fixes" which are detected by Github, followed by the issue number, e.g. "closes #1234" or "fixes #1234", this will link the commit to the issue you are working on.
- push your branch to your fork and create a pull request for it, explaining the approach you have used, any design decisions you have made.