|
1 | | -Contributing |
2 | | -============ |
| 1 | +# Contributing |
3 | 2 |
|
4 | | -**Note:** [This work](README.md) is licensed under the [Apache License 2.0](LICENSE.txt). |
5 | | -If you contribute any [non-trivial](http://www.gnu.org/prep/maintain/maintain.html#Legally-Significant) patches make sure to read and agree with the license. |
| 3 | +## Would you like to contribute code? |
6 | 4 |
|
7 | | -#### Would you like to contribute code? |
| 5 | +**Note:** [This work](README.md) is licensed under the [Apache License 2.0](LICENSE.txt). |
| 6 | +If you contribute any [non-trivial](http://www.gnu.org/prep/maintain/maintain.html#Legally-Significant) patches make |
| 7 | +sure to read and agree with the license. |
8 | 8 |
|
9 | 9 | **Note:** Keep your pull requests small, otherwise it is less likely they will get merged. |
10 | 10 |
|
| 11 | +**Note:** This project is built with [Maven](https://maven.apache.org/), see the `pom.xml` in the root folder. |
| 12 | + |
11 | 13 | 1. [Fork tmdb-java](https://github.com/UweTrottmann/tmdb-java/fork). |
12 | | -2. Create a new branch and make [great commits + messages](http://robots.thoughtbot.com/post/48933156625/5-useful-tips-for-a-better-commit-message). If you add or modify methods, make sure to also create and run basic tests (see `src/test`). |
13 | | -3. [Start a pull request](https://github.com/UweTrottmann/tmdb-java/compare) against `main`. |
| 14 | +2. Create a new branch and make great commits + messages: |
| 15 | + |
| 16 | + * Each line should be 72 characters or less. |
| 17 | + * Add a subject line and body text separated by an empty line. |
| 18 | + * Describe why this change, how does it address an issue or what side effects it has. |
| 19 | + * Link related issues or documentation as needed. |
14 | 20 |
|
15 | | -#### No code! |
16 | | -* You can [discuss or submit bug reports](https://github.com/UweTrottmann/tmdb-java/issues)! |
| 21 | +3. If you add or modify methods, make sure to also create and run basic tests (see `src/test`). |
| 22 | +4. [Start a pull request](https://github.com/UweTrottmann/tmdb-java/compare) against `main`. |
17 | 23 |
|
18 | | -Setup |
19 | | ------ |
| 24 | +## No code! |
20 | 25 |
|
21 | | -This project is built with [Maven](https://maven.apache.org/), see the `pom.xml` in the root folder. |
| 26 | +You can [discuss or submit bug reports](https://github.com/UweTrottmann/tmdb-java/issues)! |
0 commit comments