diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e9c962b..406129d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ For those who are wanting to contribute, we fully encourage doing so. There are 3. Create a new branch that describes the new feature, enhancement, or bug fix. For example, this is good: `feature/add-xyz`. This is bad: `fix-this-lol`. 4. Write the code that addresses your change. - Keep in mind that it **must** be formatted correctly. If you are using IntelliJ, there is a `codeStyle.xml` file that tells IntelliJ how to format your code. Check this link for information on how to use the file: https://www.jetbrains.com/help/idea/configuring-code-style.html#import-export-schemes -- If you are not using IntelliJ, that is fine. We use Allman style so please format your code accordingly. +- If you are not using IntelliJ, that is fine. We use Google Java Code Style in this particular Module so please format your code accordingly. 6. Push your changes to your new branch and make a PR based off of that branch. ## Requirements for a PR @@ -21,4 +21,4 @@ For those who are wanting to contribute, we fully encourage doing so. There are - Most importantly, your code must be efficient. Your pull request may be rejected if your code is deemed inefficient or sloppy. - Do not repeat yourself. Create functions as needed if you're using large blocks of code over and over again. - Do not use an excessive amount of commits when making your PR. It makes the master branch look messy. -- Your code must be consistent with Plex's codebase. If a function already exists, use it. \ No newline at end of file +- Your code must be consistent with Plex's codebase. If a function already exists, use it.