diff options
author | BrettyWhite <geekman3454@protonmail.com> | 2017-05-26 08:10:20 -0400 |
---|---|---|
committer | BrettyWhite <geekman3454@protonmail.com> | 2017-05-26 08:10:20 -0400 |
commit | e2d2e2a1d704d1d9beb27fdbaa732ff6be6c737e (patch) | |
tree | d5643877f2103e7f563a0a5df23b91f6dfaa121c | |
parent | 4a6f8110028d532915451719e2e569eb36e017b8 (diff) | |
download | sdl_android-e2d2e2a1d704d1d9beb27fdbaa732ff6be6c737e.tar.gz |
removed contributing from root, added to .github
-rw-r--r-- | .github/CONTRIBUTING.md | 9 | ||||
-rw-r--r-- | CONTRIBUTING.md | 29 |
2 files changed, 7 insertions, 31 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e7fe19e7d..8c8821977 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -18,7 +18,12 @@ We use <a href="http://nvie.com/posts/a-successful-git-branching-model/">Gitflow * All commits should separated into logical units, i.e. unrelated changes should be in different commits within a pull request. * Work in progress pull requests should have "[WIP]" in front of the Pull Request title. When you believe the pull request is ready to merge, remove this tag and @mention the appropriate SDL team to schedule a review. * All new code *must* include unit tests. Bug fixes should have a test that fails previously and now passes. All new features should be covered. If your code does not have tests, or regresses old tests, it will be rejected. -* A great example of a <a href="https://github.com/smartdevicelink/SmartDeviceLink-iOS/pull/45" target="_blank">pull request can be found here</a>. +* A great example of a <a href="https://github.com/smartdevicelink/SmartDeviceLink-iOS/pull/45" "_target>pull request can be found here</a>. ### Contributor's License Agreement (CLA) -In order to accept Pull Requests from contributors, you must first sign [the Contributor's License Agreement](https://docs.google.com/forms/d/1VNR8EUd5b46cQ7uNbCq1fJmnu0askNpUp5dudLKRGpU/viewform). If you need to make a change to information that you entered, [please contact us](mailto:justin@livio.io). +In order to accept Pull Requests from contributors, you must first sign [the Contributor's License Agreement](https://docs.google.com/forms/d/1VNR8EUd5b46cQ7uNbCq1fJmnu0askNpUp5dudLKRGpU/viewform). If you need to make a change to information that you entered, [please contact us](mailto:theresa@livio.io). + +### Repository Specific Guidelines + * <a href="https://github.com/smartdevicelink/sdl_android/wiki/Style-Guide" target="blank">Android Style Guide</a> + * Please document all code written. Write [JavaDoc style documentation](http://www.oracle.com/technetwork/articles/java/index-137868.html) for methods, and use inline code comments where it makes sense, i.e. for non-obvious code chunks. + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 8c8821977..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,29 +0,0 @@ -# Contributing to SDL Projects - -Third party contributions are essential for making SDL great. However, we do have a few guidelines we need contributors to follow. - -### Issues -If writing a bug report, please make sure <a href="http://yourbugreportneedsmore.info" target="_blank">it has enough info</a>. Include all relevant information. - -If requesting a feature, understand that we appreciate the input! However, it may not immediately fit our roadmap, and it may take a while for us to get to your request. - -### Gitflow -We use <a href="http://nvie.com/posts/a-successful-git-branching-model/">Gitflow</a> as our branch management system. Please follow gitflow's guidelines while contributing to any SDL project. - -### Pull Requests -* Please follow the repository's for all code and documentation. -* All feature branches should be based on `develop` and have the format `feature/branch_name`. -* Minor bug fixes, that is bug fixes that do not change, add, or remove any public API, should be based on `master` and have the format `hotfix/branch_name`. -* All pull requests should implement a single feature or fix a single bug. Pull Requests that involve multiple changes (it is our discretion what precisely this means) will be rejected with a reason. -* All commits should separated into logical units, i.e. unrelated changes should be in different commits within a pull request. -* Work in progress pull requests should have "[WIP]" in front of the Pull Request title. When you believe the pull request is ready to merge, remove this tag and @mention the appropriate SDL team to schedule a review. -* All new code *must* include unit tests. Bug fixes should have a test that fails previously and now passes. All new features should be covered. If your code does not have tests, or regresses old tests, it will be rejected. -* A great example of a <a href="https://github.com/smartdevicelink/SmartDeviceLink-iOS/pull/45" "_target>pull request can be found here</a>. - -### Contributor's License Agreement (CLA) -In order to accept Pull Requests from contributors, you must first sign [the Contributor's License Agreement](https://docs.google.com/forms/d/1VNR8EUd5b46cQ7uNbCq1fJmnu0askNpUp5dudLKRGpU/viewform). If you need to make a change to information that you entered, [please contact us](mailto:theresa@livio.io). - -### Repository Specific Guidelines - * <a href="https://github.com/smartdevicelink/sdl_android/wiki/Style-Guide" target="blank">Android Style Guide</a> - * Please document all code written. Write [JavaDoc style documentation](http://www.oracle.com/technetwork/articles/java/index-137868.html) for methods, and use inline code comments where it makes sense, i.e. for non-obvious code chunks. - |