|
| 1 | +# Contributing to SerialX |
| 2 | + |
| 3 | +First off, thank you for considering contributing to this project. It's people like you that make this project even better! |
| 4 | + |
| 5 | +## How Can I Contribute? |
| 6 | + |
| 7 | +### Reporting Bugs |
| 8 | + |
| 9 | +- **Ensure the bug was not already reported** by searching on GitHub under [Issues section](https://github.com/PetoPetko/Java-SerialX/issues). |
| 10 | +- 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. |
| 12 | + |
| 13 | +### Your First Code Contribution |
| 14 | + |
| 15 | +- Fork the repo. |
| 16 | +- Windows only: Download [Git bash x64](https://git-scm.com/download/) if you do not have it already. |
| 17 | +- Open bash/git bash then run the following command and write in your GitHub account name (SimplyProgrammer in my case). This command should properly clone your forked SerialX repo: |
| 18 | +``` |
| 19 | +read -p "Enter your GitHub account name: " name && mkdir -p SerialX && cd "$_" && |
| 20 | +git clone --single-branch --branch dev "https://github.com/$name/Java-SerialX.git" SerialXDev && |
| 21 | +git clone --single-branch --branch tests-and-experimental-features "https://github.com/$name/Java-SerialX.git" SerialXTest |
| 22 | +``` |
| 23 | +- Import both SerialXDev and SerialXTest together with all of their modules into your editor of choice, I recommend Eclipse. |
| 24 | +- Make some changes (add something feature, fix some bugs, improve Javadocs...) |
| 25 | +- 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! |
| 26 | +- 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)'`). |
| 28 | +- Push to the branch (`git push`). |
| 29 | +- When you are done, open a new Pull Request. |
| 30 | + |
| 31 | +## Styleguides and code requirements |
| 32 | +- Follow general Java conventions. |
| 33 | +- Introduce as few boundaries as possible, try making things as universal as possible (do not use final or private if possible). |
| 34 | +- Try for your code to not stick out stylistically ;) |
| 35 | +- 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! |
| 37 | +- 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. |
| 38 | +- Note: Version does not have to be incremented in any way, adding _SNAPSHOT at the end should be sufficient. |
| 39 | + |
| 40 | +## Additional |
| 41 | + |
| 42 | +Thank you for contributing to SerialX! |
0 commit comments