You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+26Lines changed: 26 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,6 +50,8 @@ All successfully merged pull requests must meet the following criteria:
50
50
51
51
* Code must be clean, readable, and commented. How you do that is up to you!
52
52
53
+
* The PR template, which covers most of these points, should be filled out.
54
+
53
55
Don't worry if you submit a pull request and all the tests break and the code is not readable. We won't merge it just yet and then you can get some feedback about what needs to be changed before we do!
54
56
55
57
### Be welcoming
@@ -66,6 +68,10 @@ Unsure where to begin contributing to Poly? You can start by looking through the
66
68
67
69
[Feature requests](https://github.com/bebop/poly/labels/enhancement) - before requesting a new feature search through previous feature requests to see if it's already been requested. If not then feel free to submit a request and tag it with the enhancement tag!
68
70
71
+
## Taking issues
72
+
To assign an issue to yourself, simply comment `.take` on it and it will be
73
+
assigned to you!
74
+
69
75
### Working on your first Pull Request?
70
76
71
77
You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
@@ -148,6 +154,26 @@ and tag to the repository, and GitHub Actions will automatically make a release!
148
154
[here](https://github.com/bebop/poly/releases/tag/nightly). These will reflect the status
149
155
of the `main` branch as of 0800UTC/0300EST.
150
156
157
+
# Issue management
158
+
As `poly` grows, we will see more and more issues added to our GitHub. This will
159
+
require us to be disciplined about properly labeling issues for easier
160
+
discoverability and task assignment. Issues will also be tracked in the Projects
161
+
section of the repository.
162
+
163
+
## Triaging new issues
164
+
All new issues will be marked with the `needs-triage` label, which should
165
+
promptly be replaced with the following:
166
+
167
+
- An issue type label (`devops`, `bug`, `ux`, `question`, `proposal`, `enhancement`, `documentation`)
168
+
- A difficulty/effort label (`easy`, `intermediate`, `hard`)
169
+
- A priority label (`high priority`, `normal priority`, `low priority`)
170
+
- OPTIONAL: `help wanted` or `good first issue` where appropriate
171
+
172
+
## Stale issues
173
+
After 2 months of no activity, issues will be marked with the `stale` label.
174
+
We should periodically sort through `stale` issues and either close them
175
+
or assign them.
176
+
151
177
# In closing
152
178
153
179
Thanks for reading and I'm super psyched to see what you'll do with Poly!
0 commit comments