8000 Update CONTRIBUTING.md · SimplyProgrammer/Java-SerialX@643e18b · GitHub
[go: up one dir, main page]

Skip to content

Commit 643e18b

Browse files
Update CONTRIBUTING.md
gram...
1 parent 2a64d25 commit 643e18b

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ First off, thank you for considering contributing to this project. It's people l
88

99
- **Ensure the bug was not already reported** by searching on GitHub under [Issues section](https://github.com/PetoPetko/Java-SerialX/issues).
1010
- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/PetoPetko/Java-SerialX/issues/new).
11-
- Make sure that the issue contains well enough description and if possible some additional data as well, such as code examples. This can help to better understand the issue or ease the reproduction process.
11+
- Make sure that the issue contains decent description and if possible some additional data as well, such as code examples. This can help to better understand the issue or ease the reproduction process.
1212

1313
### Your First Code Contribution
1414

@@ -24,7 +24,7 @@ git clone --single-branch --branch tests-and-experimental-features "https://gith
2424
- Make some changes (add something feature, fix some bugs, improve Javadocs...)
2525
- Go to SerialXTest and run `examples.implementations.GeneralExample`, `examples.implementations.SimpleQuerying` and `examples.implementations.SerializingWithJson` junit tests. Acknowledge that only changes that meet all the tests can be added to the library!
2626
- If all the tests are green you can `git add .`
27-
- Commit your changes (`git commit -am 'describe what you have done (adding/fixing/etc something)'`).
27+
- Commit your changes (`git commit -am 'describe what you have done (adding/fixing/improving/... something)'`).
2828
- Push to the branch (`git push`).
2929
- When you are done, open a new Pull Request.
3030

@@ -33,7 +33,7 @@ git clone --single-branch --branch tests-and-experimental-features "https://gith
3333
- Introduce as few boundaries as possible, try making things as universal as possible (do not use final or private if possible).
3434
- Try for your code to not stick out stylistically ;)
3535
- Every added feature must have an outreaching purpose, must be tested, and perform reasonably.
36-
- Make sure to NOT alter any of the tests unless your use case explicitly requires it, in that case make sure to document it!
36+
- Make sure to NOT alter any of the tests unless your use case explicitly requires it, in that case, make sure to document it!
3737
- Every added class and method must be documented (/** doc */) and contain @author and @version. Method does not need to have @author, especially @author of the class is the same.
3838
- Note: Version does not have to be incremented in any way, adding _SNAPSHOT at the end should be sufficient.
3939

0 commit comments

Comments
 (0)
0