From b2075947dc9fb25729bdfe61a8500fb4ba1f992f Mon Sep 17 00:00:00 2001 From: Prashant Sunkari Date: Tue, 6 Oct 2015 13:09:23 -0700 Subject: [PATCH] Bug 14 - 'Pull request' guideline formatting Fixing the bug#14. 1. Pull request guidelines points are now formatted in their own line 2. Added a wiki link to indicate what lint roughly means in this context. Current guideline about lint is not appropriate for this java project. > 'lint' reference makes more sense for javascript project with grunt. Example: https://github.com/facebook/react/blob/master/CONTRIBUTING.md#pull-requests --- CONTRIBUTING.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 57f3d49..69b9148 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,12 +9,14 @@ is used directly for issues and pull requests and the developers actively respond to requests. ## Pull Requests -We actively welcome your pull requests. +We actively welcome your pull requests. Before submitting a pull request, +please make sure the following is done: + 1. Fork the repo and create your branch from `master`. -2. If you've added code that should be tested, add tests +2. If you've added code that should be tested, add tests! 3. If you've changed APIs, update the documentation. 4. Ensure the test suite passes. -5. Make sure your code lints. +5. Make sure your code [lints](https://en.wikipedia.org/wiki/Lint_(software)). 6. If you haven't already, complete the Contributor License Agreement ("CLA"). ## Contributor License Agreement ("CLA") @@ -41,4 +43,4 @@ outlined on that page and do not file a public issue. ## License By contributing to Network Connection Class, you agree that your contributions will be licensed -under its BSD license. \ No newline at end of file +under its BSD license.