Skip to content

Commit

Permalink
CONTRIBUTING: note about copyright line, test credentials expiring
Browse files Browse the repository at this point in the history
  • Loading branch information
UweTrottmann committed Aug 30, 2024
1 parent a0b109f commit 1e33aa7
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ If you contribute any [non-trivial](http://www.gnu.org/prep/maintain/maintain.ht
Keep your pull requests small, otherwise it is less likely they will get merged.

1. [Fork trakt-java](https://github.com/UweTrottmann/trakt-java/fork).
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`).
2. Create a new branch and make [great commits](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`).
- If you make non-trivial changes (see above), make sure to add a copyright line at the top of the file.
3. [Start a pull request](https://github.com/UweTrottmann/trakt-java/compare) against `main`.

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

This project is built with [Maven](https://maven.apache.org/), see the `pom.xml` in the root folder.

The tests provide temporary credentials (see [BaseTestCase](src/test/java/com/uwetrottmann/trakt5/BaseTestCase.java)),
so running tests should just work.
If an unauthorized error is returned, let me know that the test credentials need to be refreshed.

0 comments on commit 1e33aa7

Please sign in to comment.