waycrate / swhkd

Sxhkd clone for Wayland (works on TTY and X11 too)
https://git.sr.ht/~shinyzenith/swhkd
BSD 2-Clause "Simplified" License
694 stars 47 forks source link

Issue labels and management #188

Closed ajanon closed 1 year ago

ajanon commented 1 year ago

We currently have very few issue labels, and few ways to sort issues. I think this could be improved to make it easier for both users and maintainers to work on this. The main goal of this issue is to start a discussion. All ideas presented here are debatable, so feel free to chip in!

Priority

Personally, I would like to have a way to assign priority to issues, to help focus development:

Alternatively, P: high.

Instead of priority, bugs could instead be labeled 'Severity'. If something is truly blocking users, this could then be looked at first.

Difficulty

Second, attributing approximate difficulty to issues would also help (especially for newcomers):

Alternatively: D: high or to mimic the Rust project: E: high with E standing for Experience.

Combined with the Priority/Severity label, this could help in deciding on what to work: a high priority, low complexity task is basically a low-hanging fruit and could even be worked on by external occasional contributors. We could keep good first issue and ħelp wanted as they seem to complement this nicely.

Component

I don't think any of us is an expert on the whole codebase. Categorizing issues based on what code is impacted would really help developers focus on their own area of expertise. Deciding what is or is not a component in swhkd may not be straightforward and may need some discussion. Here are some ideas:

Again, this could be shortened to C: swhks for instance.

If possible, I think all these should be assignable by maintainers only (especially for priority or difficulty).

Shinyzenith commented 1 year ago

Is shorthand ideal here? (for example D: high or E: high) That might be confusing for new contributors. I'm all for Difficulty/Experience/Component.

ajanon commented 1 year ago

You're right, I think the shorthand version is a bit confusing.

If we find the longer version too verbose at some point, we can always change to the shorthand.

Shinyzenith commented 1 year ago

Yep that works! I'll go ahead and make the labels and we can slowly start to triage issues as we start working on them.

Shinyzenith commented 1 year ago

I've created the labels. I'll go ahead and close this issue and slowly start triaging all reports.

Note: all the labels apart from bug are gated to maintainers.