Skip to content

Commit 2d892af

Browse files
committed
Contributing guide: clean up and improve
1 parent 7249508 commit 2d892af

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,26 @@
1-
Contributing
2-
============
1+
# Contributing
32

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?
64

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.
88

99
**Note:** Keep your pull requests small, otherwise it is less likely they will get merged.
1010

11+
**Note:** This project is built with [Maven](https://maven.apache.org/), see the `pom.xml` in the root folder.
12+
1113
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.
1420

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`.
1723

18-
Setup
19-
-----
24+
## No code!
2025

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

Comments
 (0)