Adding instructions for breaking issues into sub-issues - #72
Open
jjkurczak wants to merge 3 commits into
Open
Conversation
Adding section regarding sub-issues usage, pointing to a new ISSUES_STYLE_GUIDE.md file to be created next
Adding instructions and template for sub-issue creation, and an optional template for Issues as well.
Updated Creating Sub-issues section, added correct link to issues style guide.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When working on big issues, it may be beneficial for contributors and reviewers to break the issue up into smaller sub-issues, each with separate pull-requests. However, breaking an issue up into smaller PRs could result in unexpected breakages or incomplete tasks if not handled with care by contributors. Therefore, a new ISSUES_STYLE_GUIDE.md has been added with mandatory instructions for using the sub-issues feature (and an optional template for creating regular issues), and a section on sub-issues has been added to CONTRIBUTING.md that points to this new style guide.