-
Notifications
You must be signed in to change notification settings - Fork 0
Contribute to MCT
Awesome, you want to contribute to MCT!
We especially welcome feature enhancements and bug fixes described on our issue tracker. However, before you dive in, please ensure the issue is not already assigned to someone and then be sure to assign the issue to yourself.
We also welcome any other feature enhancements and bug fixes. Before you get started, please browse our issues to see if it has already been listed. If it has not been listed, please create the issue and thoroughly document it using the instructions below.
Bug: describe the bug in detail and thoroughly document steps for replication
Feature: describe the feature enhancement in detail and explain how it's necessary, interesting or useful
A great way designers and testers can contribute is by updating and documenting new bug fixes or feature enhancements on our issue tracker.
If you're new to Git / GitHub, try.github.io is an excellent interactive learning tool that will quickly teach what you need to know. A deeper explanation is available in the paper Git from the bottom up and the comprehensive, official reference is the Pro Git book, available for free online.
Contributing developers should have their own fork of MCT. You may submit a pull request when you think it's appropriate to merge your fork with the NASA MCT repository.
When submitting your pull request, include a high level description of the changes and / or additions, a list of all new and modified files and the below template, with answers and explanations.
Wrote or re-wrote unit tests (Y/N):
Ran entire suite of unit tests successfully (Y/N):
Verified bug fix with the described replication steps or verified the implementation meets the requirement cited (Y/N):
Code coverage requirements satisfied (new code=80%, changed code=at least as high as existing) (Y/N):
Code review date and attendees:
Describe potential impact on other areas of the code:
Describe any test prerequisites for this fix (e.g., restart the database):
For bugs marked "Regression - Yes", describe the cause of the regression:
Did you modify any pom.xml file? If yes, did you thoroughly document your changes and reasons?
For any "No" or N/A answers above, provide justification.
Run mvn clean install -Ddistribution to discover code checker failures in your workspace, before submitting your pull request.
If you have any questions about this process, please ask. Thanks for contributing!