Create CONTRIBUTING.md #151
Open
Conversation
This file contains 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
2 tasks
|
I have some reservations with adding the file as is. Are we going ro follow the steps and procedures that are mentioned in here? I'm specifically worried about the labels and how we are going to manage them. |
froi
requested changes
Mar 1, 2021
| * If you or the maintainers don't respond to an issue for 30 days, the [issue will be closed](#clean-up-issues-and-prs). If you want to come back to it, reply (once, please), and we'll reopen the existing issue. Please avoid filing new issues as extensions of one you already made. | ||
| * `critical` issues may be left open, depending on perceived immediacy and severity, even past the 30 day deadline. | ||
|
|
||
| ## Request a Feature |
There was a problem hiding this comment.
I don't think we should be using issues for feature requests.
I've enabled discussions for this repo. I think that we should move any open ended feature request, question, or discussion to this area. It will help us keep issues to bugs and actionable items. This way we can treat our issues as a proper backlog.
| `critical` | Added to `bug` issues if the problem described makes the code completely unusable in a common situation. | | ||
| `documentation` | Added to issues or pull requests that affect any of the documentation for the project. | Can be combined with other labels, such as `bug` or `enhancement`. | ||
| `duplicate` | Added to issues or PRs that refer to the exact same issue as another one that's been previously labeled. | Duplicate issues should be marked and closed right away, with a message referencing the issue it's a duplicate of (with `#123`) | ||
| `enhancement` | Added to [feature requests](#request-a-feature), PRs, or documentation issues that are purely additive: the code or docs currently work as expected, but a change is being requested or suggested. | |
There was a problem hiding this comment.
feature requests should be moved to discussions. See previous comment.
Suggested change
| `enhancement` | Added to [feature requests](#request-a-feature), PRs, or documentation issues that are purely additive: the code or docs currently work as expected, but a change is being requested or suggested. | | |
| `enhancement` | Added to issues (including those for documentation) or PRs that are purely additive: the code or docs currently work as expected, but a change is being suggested. | |
| `performance` | This issue or PR is directly related to improving performance. | | ||
| `refactor` | Added to issues or PRs that deal with cleaning up or modifying the project for the betterment of it. | | ||
| `starter` | Applied by [Committers](#join-the-project-team) to issues that they consider good introductions to the project for people who have not contributed before. These are not necessarily "easy", but rather focused around how much context is necessary in order to understand what needs to be done for this project in particular. | Existing project members are expected to stay away from these unless they increase in priority. | ||
| `support` | This issue is either asking a question about how to use the project, clarifying the reason for unexpected behavior, or possibly reporting a `bug` but does not have enough detail yet to determine whether it would count as such. | The label should be switched to `bug` if reliable reproduction steps are provided. Issues primarily with unintended configurations of a user's environment are not considered bugs, even if they cause crashes. |
There was a problem hiding this comment.
Support request or conversation should be moved to discussions.
Suggested change
| `support` | This issue is either asking a question about how to use the project, clarifying the reason for unexpected behavior, or possibly reporting a `bug` but does not have enough detail yet to determine whether it would count as such. | The label should be switched to `bug` if reliable reproduction steps are provided. Issues primarily with unintended configurations of a user's environment are not considered bugs, even if they cause crashes. |
| `in-progress` | Applied by [Committers](#join-the-project-team) to PRs that are pending some work before they're ready for review. | The original PR submitter should @mention the team member that applied the label once the PR is complete. | ||
| `performance` | This issue or PR is directly related to improving performance. | | ||
| `refactor` | Added to issues or PRs that deal with cleaning up or modifying the project for the betterment of it. | | ||
| `starter` | Applied by [Committers](#join-the-project-team) to issues that they consider good introductions to the project for people who have not contributed before. These are not necessarily "easy", but rather focused around how much context is necessary in order to understand what needs to be done for this project in particular. | Existing project members are expected to stay away from these unless they increase in priority. |
There was a problem hiding this comment.
starter label should be good first issue. good first issue is a default label for new repositories, this will let us reuse this file as a template with minimal changes.
Suggested change
| `starter` | Applied by [Committers](#join-the-project-team) to issues that they consider good introductions to the project for people who have not contributed before. These are not necessarily "easy", but rather focused around how much context is necessary in order to understand what needs to be done for this project in particular. | Existing project members are expected to stay away from these unless they increase in priority. | |
| `good first issue` | Applied by [Committers](#join-the-project-team) to issues that they consider good introductions to the project for people who have not contributed before. These are not necessarily "easy", but rather focused around how much context is necessary in order to understand what needs to be done for this project in particular. | Existing project members are expected to stay away from these unless they increase in priority. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
#149