diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 85de5ad77..9c3b9e0a3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,12 +24,69 @@ When opening a new issue be sure to document: ### Requesting new features -Please review the list of open Issues to see if one is already open. Please review all categories, Bugs and -Enhancements. Also check for Closed Issues before opening a new one. +Please review the list of open Issues to see if one is already open. Please review all categories, Bugs and enhancements. Also check for Closed Issues before opening a new one. +If you have a small enhancement that is well defined, please create a new feature request on GitHub. + +If you have a larger idea for a new feature please share it with us on [Microsoft Azure Feedback Forums](https://feedback.azure.com/forums/920053) where the rest of the community can up vote it too. We will review the submitted ideas very frequently, usually twice weekly. + +Below is our list of possible status states we may assign to the request: + +| Microsoft Azure Feedback Forums status| Process steps definition +|---------------------------------------|---------------------------------------| +| No status | New issue we have not looked at yet | +| Need Feedback | Idea doesn't have enough details or needs more community support | +| Under Review | Proposal for the new feature is created and in review | +| Planned | Approved to get the work started | +| Started | Work started | +| Completed | Feature is released | +| Declined | We have decided not to make this change | +| Moved | Issue which has been moved to GitHub | +| Archived | Feature not possible to implement on current HW. | +| Triaged | Request has been seen and is under internal discussion | + +#### No status + +This is a new request that we have not yet seen. Within a week we should have reviewed the request and assigned it an initial state. + +#### Needs Feedback + +The Azure Kinect team uses this state to ask for more information about this issue. We may need more information from the issue filer as we don't completely understand the request. We might also use this status because we are waiting for more community feedback on the proposal; either in the form of spec feedback or up voting. + +#### Under Review + +The team is actively reviewing the proposal and determine what the next actions should be. We may ask for more information, iterate on the proposal, or move to planned state while we wait for resources. We will also need to carefully consider not only the work to implement the request but the work needed to be invested our build and test infrastructure to ensure quality of the code remains high. + +#### Planned + +The requested issue has been planned but not yet started. It may stay in this state indefinitely if we don't have resources to complete the request. + +#### Started + +Work on the feature, new tests, and possible infrastructure changes have begun. + +#### Completed + +The requested issue has been checked into develop branch and we are done. The feature however, may not yet be part of a release. + +#### Declined + +We have consider the request and have decided not to implement it due to various reasons. For example, the idea cannot be implemented with the current hardware. + +#### Moved + +Issue has been moved to GitHub for tracking. + +#### Archived + +We will archive the idea if the current hardware can't support the request. + +#### Triaged + +We use the this status to indicate that request has been seen and is under internal discussion. ## Finding issues you can help with -Looking for something to work on? Issues marked [``Good First Issue``](https://github.com/Microsoft/Azure-Kinect-Sensor-SDK/labels/good%20first%20issue) +Looking for something to work on? Issues marked [``Good First Issue``](https://github.com/Microsoft/Azure-Kinect-Sensor-SDK/labels/good%20first%20issue) are a good place to start. You can also check the [``Help Wanted``](https://github.com/Microsoft/Azure-Kinect-Sensor-SDK/labels/help%20wanted) tag to