diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 0000000000000000000000000000000000000000..03fdfcddc29339a4ba92a923bb7c7fdf07ca19c7 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,38 @@ +# Contributing to ISIS3 +# Under Construction +The following is a set of guidelines for contributing to ISIS3. +#### Table of Contents +[I have a problem or a question](#redmine-issues) +[Redmine Issues](#redmine-issues) +[How can I contribute?](#steps-to-contribute) + * [Report an issue](#redmine-issues) + * [Suggesting enhancements](#redmine-issues) + * [Working on an existing issue](#working-on-an-issue) + * [Working on an existing enhancement](#working-on-an-enhancement) + * [Working on a new issue or enhancement](#working-on-a-new-issue) +[What can I expect from the ISIS3 development team](#What-can-I-expect-from-the-ISIS3-development-team) + * [Response time](#Response-time) + * [Feedback](#feedback) +[Development Process Checklists] +[References] + * [ISIS3 API Reference](https://isis.astrogeology.usgs.gov/Object/Developer/index.html) + * [Tutorials](https://isis.astrogeology.usgs.gov/fixit/projects/isis/wiki/ISIS_Online_Workshops) + * [Application Documentation](https://isis.astrogeology.usgs.gov/Application/index.html) + * [Coding Standards and Style Guide](https://isis.astrogeology.usgs.gov/documents/CodingStandards/CodingStandards.html) + * [Documentation](https://isis.astrogeology.usgs.gov/documents/CodingStandards/CodingStandards.html#documentation) + * [Redmine Issue Lifecycle](https://isis.astrogeology.usgs.gov/fixit/projects/isis/wiki/Life_Cycle_of_an_ISIS_Issue) + * ADD MORE THINGS!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +## How can I contribute? +There's lots of ways to contribute to ISIS3. + +### Working on an existing issue +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. +2. Propose a solution on the redmine issue. +3. Work with other developers and the issue reporter to improve your solution. +4. Add an 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. +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 #<Insert issue number> 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.