From 35539cb60cef6aee78f9976b84e26c9e3389f3f9 Mon Sep 17 00:00:00 2001 From: Makayla Shepherd <mshepherd@usgs.gov> Date: Thu, 29 Mar 2018 16:04:54 -0700 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e4f7f27de0..b60588d512 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,8 +9,7 @@ [How can I contribute?](#how-can-i-contribute) * [Report an issue](#redmine-issues) * [Suggesting enhancements](#redmine-issues) - * [Working on an existing issue](#working-on-an-existing-issue) - * [Working on an existing enhancement](#working-on-an-enhancement) + * [Working on an existing issue or enhancement](#working-on-an-existing-issue-or-enhancement) * [Working on a new issue or enhancement](#working-on-a-new-issue) [Code Base Contribution Guidelines](#code-base-contribution-guidelines) @@ -39,9 +38,8 @@ If you have a question or a problem with contributing to our software please con If you have a question about, a problem with, or a suggestion for ISIS3, please read our [Guidelines for reporting Redmine issues](https://isis.astrogeology.usgs.gov/fixit/projects/isis/wiki/Guidelines_for_Reporting_Issues). Once you have read that please [submit](https://isis.astrogeology.usgs.gov/fixit/projects/isis/issues/new) a Redmine issue. ## How can I contribute? -There's lots of ways to contribute to ISIS3. -### Working on an existing issue +### Working on an existing issue or enhancement 1. Assign the redmine issue to yourself. If you don't have the permission to do this, please make a note on the issue that you would like to work on it. Please contact ## REGENT EMAIL HERE ## for permission to work on an issue. 2. Propose a solution on the redmine issue. 3. Work with an ISIS3 developer, the issue reporter, and any other interested parties to get feedback on your solution. This may be an iterative process. @@ -51,14 +49,19 @@ There's lots of ways to contribute to ISIS3. 7. Make a pull request. Include the redmine issue number in the title of the pull request. Use the "Fixes #0000" format. 8. Work with your code reviewer, tester, and reporter to improve your changes. Your pull request will not be merged in until all parties approve the changes. 9. Check in your test data. If you are an outside contributer, work with your code reviewer to ensure your tests and test data get checked in. + +### Working on a new issue or enhancement +1. Please create a [Redmine issue](#redmine-issues). +2. Indicate in the comments of your issue that you would like to work on the issue or enhancement. +3. Follow the [Working on an existing issue or enhancement](#working-on-an-existing-issue-or-enhancement) steps. ## Code Base Contribution Guidelines The following is a set of guidelines for contributing to ISIS3. -* Personal style changes will not be accepted +* Personal style changes will not be accepted. * Changes to bring code closer to our [Coding Standards and Style Guide](https://isis.astrogeology.usgs.gov/documents/CodingStandards/CodingStandards.html) are encouraged. -* Please be professional, even in comments -* Variable names must be meaningful -* All modified code is required to pass our [Coding Standards and Style Guide](https://isis.astrogeology.usgs.gov/documents/CodingStandards/CodingStandards.html) +* Please be professional, even in comments. +* Variable names must be meaningful. +* All modified code is required to pass our [Coding Standards and Style Guide](https://isis.astrogeology.usgs.gov/documents/CodingStandards/CodingStandards.html). * You must write or update tests to exercise any modified code. * You must provide test data for any new or modified tests. * You must have a Redmine issue assigned to you before submitting a pull request. -- GitLab