Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 1.75 KB

File metadata and controls

47 lines (29 loc) · 1.75 KB

Contributing

Would you like to contribute code?

Note: This work is licensed under the Apache License 2.0. If you contribute any non-trivial patches make sure to read and agree with the license.

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

Note: This project is built with Maven, see the pom.xml in the root folder.

  1. Fork tmdb-java.

  2. Create a new branch and make great commits + messages:

    • Each line should be 72 characters or less.
    • Add a subject line and body text separated by an empty line.
    • Describe why this change, how does it address an issue or what side effects it has.
    • Link related issues or documentation as needed.
  3. If you add or modify methods, make sure to also create and run basic tests (see src/test).

  4. Start a pull request against main.

Setting up Test Credentials

The tests require a TMDB API key to run:

  • TEST_API_KEY: a TMDB API key

It can be set either

If both are set, the environment variable takes precedence over the properties file.

Getting Credentials

To obtain a TMDB API key:

  1. Create or sign in to a TMDB account at https://www.themoviedb.org/
  2. Create an API key at https://www.themoviedb.org/settings/api
  3. Copy the API Key and set it as TEST_API_KEY

No code!

You can discuss or submit bug reports!