diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d127c990..b36103b1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,12 +4,12 @@ If you think you can contribute code to the Tautulli repository, do not hesitate to submit a pull request. ### Branches -All pull requests should be based on the `dev` branch, to minimize cross merges. When you want to develop a new feature, clone the repository with `git clone origin/dev -b FEATURE_NAME`. Use meaningful commit messages. +All pull requests should be based on the `nightly` branch, to minimize cross merges. When you want to develop a new feature, clone the repository with `git clone origin/nightly -b FEATURE_NAME`. Use meaningful commit messages. ### Python Code #### Compatibility -The code should work with Python 2.7. Note that Tautulli runs on different platforms, including Network Attached Storage devices such as Synology. +The code should work with Python 2.7. Note that Tautulli runs on many different platforms. Re-use existing code. Do not hesitate to add logging in your code. You can the logger module `plexpy.logger.*` for this. Web requests are invoked via `plexpy.request.*` and derived ones. Use these methods to automatically add proper and meaningful error handling. @@ -29,13 +29,10 @@ Although Tautulli did not adapt a code convention in the past, we try to follow #### Documentation Document your code. Use docstrings See [PEP-257](https://www.python.org/dev/peps/pep-0257/) for more information. -#### Continuous Integration -Tautulli has a configuration file for [travis-ci](https://travis-ci.org/). You can add your forked repo to Travis to have it check your code against PEP8, PyLint, and PyFlakes for you. Your pull request will show a green check mark or a red cross on each tested commit, depending on if linting passes. - ### HTML/Template code #### Compatibility -HTML5 compatible browsers are targetted. There is no specific mobile version of Tautulli yet. +HTML5 compatible browsers are targeted. #### Conventions * 4 space indentation