diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 919ebf0ae2715b59ded0ad36ecb5fa284bc4db88..78b2d0aed5045de238446e145daa9c43d9b9d1b1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,18 +27,19 @@ If you have a question or a problem with contributing to our software please con ## How can I contribute? ### Redmine Issues -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. +Redmine is our ticket tracking tool. 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. -### 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 indicating that you would like to work on it. -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. -4. Add an [impact statement](https://isis.astrogeology.usgs.gov/fixit/projects/isis/wiki/Impact_Statement) to the redmine issue. If you don't have the permission to do this, please make a note on the issue with the impact statement. -5. Make the changes on your fork of the ISIS3 main GitHub repo. Follow the [Code Base Contribution Guidelines](#code-base-contribution-guidelines). -6. Follow the Developer's Checklist to ensure your changes are ready for review. -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 an issue or enhancement +1. Find a issue or enhancement that you want to work on. Check Redmine [issues](https://isis.astrogeology.usgs.gov/fixit/projects/isis/issues) to see if there has been a ticket reported about it. If one does not exist that addresses what you want to work on, make a ticket. +2. Assign the Redmine issue to yourself. If you don't have the permission to do this, please make a note on the issue indicating that you would like to work on it. +3. Propose a solution on the redmine issue. +4. 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. +5. Add an [impact statement](https://isis.astrogeology.usgs.gov/fixit/projects/isis/wiki/Impact_Statement) to the redmine issue. If you don't have the permission to do this, please make a note on the issue with the impact statement. +6. Make the changes on your fork of the ISIS3 main GitHub repo. Follow the [Code Base Contribution Guidelines](#code-base-contribution-guidelines). +7. Follow the Developer's Checklist to ensure your changes are ready for review. +8. Make a pull request. Include the redmine issue number in the title of the pull request. Use the "Fixes #0000" format. +9. 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. +10. 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).