Skip to content

Commit 1e33aa7

Browse files
committed
CONTRIBUTING: note about copyright line, test credentials expiring
1 parent a0b109f commit 1e33aa7

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ If you contribute any [non-trivial](http://www.gnu.org/prep/maintain/maintain.ht
88
Keep your pull requests small, otherwise it is less likely they will get merged.
99

1010
1. [Fork trakt-java](https://github.com/UweTrottmann/trakt-java/fork).
11-
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 endpoints, make sure to also create and run basic tests (see `src/test`).
11+
2. Create a new branch and make [great commits](http://robots.thoughtbot.com/post/48933156625/5-useful-tips-for-a-better-commit-message).
12+
- If you add or modify endpoints, make sure to also create and run basic tests (see `src/test`).
13+
- If you make non-trivial changes (see above), make sure to add a copyright line at the top of the file.
1214
3. [Start a pull request](https://github.com/UweTrottmann/trakt-java/compare) against `main`.
1315

1416
#### No code!
@@ -17,3 +19,7 @@ Keep your pull requests small, otherwise it is less likely they will get merged.
1719
## Setup
1820

1921
This project is built with [Maven](https://maven.apache.org/), see the `pom.xml` in the root folder.
22+
23+
The tests provide temporary credentials (see [BaseTestCase](src/test/java/com/uwetrottmann/trakt5/BaseTestCase.java)),
24+
so running tests should just work.
25+
If an unauthorized error is returned, let me know that the test credentials need to be refreshed.

0 commit comments

Comments
 (0)