Skip to content

Commit 50ab331

Browse files
authored
doc: add a guide for issues filtering in CONTRIBUTING.md (#19347)
1 parent 5d1f87c commit 50ab331

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

CONTRIBUTING.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,60 @@ Git is very flexible, so there are other ways to accomplish the same thing.
133133
See the [GitHub flow](https://guides.github.com/introduction/git-handbook/#github), for more
134134
information.
135135

136+
## Finding issues to contribute to
137+
138+
If you're willing to contribute to V but don't know which issue to resolve
139+
- you can go to [Issues](https://github.com/vlang/v/issues) tab
140+
in this repository. There you can see things logged by both users and developers
141+
that need to be discussed and/or resolved.
142+
143+
It's recommended to filter issues by likes and labels to find an issue
144+
you are interested in.
145+
146+
### Filtering by likes (recommended)
147+
148+
Filtering by likes helps you identify high-impact issues.
149+
More likes mean more community interest.
150+
151+
To apply this filter, navigate to [Issues](https://github.com/vlang/v/issues)
152+
tab, then paste the following in the "Filter" field:
153+
154+
```
155+
is:open is:issue sort:reactions-+1-desc
156+
```
157+
158+
This filter will return all open issues sorted by likes in descending order.
159+
160+
### Filtering by labels
161+
162+
The V repo has various labels to help navigate the extensive list of issues
163+
and help you find issues you're both interested in and capable of resolving.
164+
You can examine the list of labels [here](https://github.com/vlang/v/labels).
165+
166+
The most common labels are:
167+
168+
By issue type:
169+
- `Bug`
170+
- `Feature Request`
171+
172+
By OS:
173+
- `OS: Linux`
174+
- `OS: Windows`
175+
- `OS: Mac`
176+
177+
By status:
178+
- `Status: Confirmed`
179+
180+
To apply this filter, navigate to [Issues](https://github.com/vlang/v/issues)
181+
tab, then paste the following in the "Filter" field:
182+
183+
```
184+
is:open is:issue label:Bug label:"OS: Windows" label:"Status: Confirmed"
185+
```
186+
187+
This filter will return all open issues with the labels `Bug`, `OS: Windows`,
188+
and `Status: Confirmed`.
189+
136190
## Using Github's hub CLI tool
137191

138192
You can download the `hub` tool from https://hub.github.com/ . Using

0 commit comments

Comments
 (0)