Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(github): Replace feature request as issues with ideas as discussions #2672

Merged
merged 2 commits into from
Sep 13, 2023

Conversation

Savio-Sou
Copy link
Collaborator

Description

Problem*

Noir's feature requests are currently collected and managed as GitHub Issues.

This is not ideal as:

Suggesting "Issues" is unintuitive

The term "Issue" could carry the meaning of "problems / bugs", which leads to GitHub Issues not necessarily being the first place users would check if they would like to raise a suggestion.

Upvoting is unintuitive

The thumbs-up emoji can be used as a pseudo upvote, but it is hidden behind the "reaction" smiley face and doesn't show up in the Issue list unless explicitly sorting with it.

Mental barrier

Filing a GitHub Issue often comes with a mental barrier that it should be logically-detailed and well-written, which might deter users from creating a suggestion.

Summary*

GitHub Discussions could potentially be a better place for collecting and managing feature requests.

This PR:

  • Removes the existing feature request GitHub Issue template (in favor of the org-wide ideas GitHub Discussions template)
  • Adds an "Ideas" contact link in the list of actions on the "New Issue" page (for users that are used to / prefer creating feature requests through the creating GitHub Issues workflow)

Documentation

  • This PR requires documentation updates when merged.

    • I will submit a noir-lang/docs PR.
    • I will request for and support Dev Rel's help in documenting this PR.

Additional Context

For a glimpse of how this would look like in action, checkout the demo noir-lang org: https://github.com/noir-lang-test/noir/issues/new/choose

For ideas that contributors would like to work on, they can easily convert discussions into GitHub Issues and follow up with the usual GitHub engineering workflow:
image

PR Checklist*

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

@Savio-Sou Savio-Sou changed the title chore(github): Remove feature request issue template; add link to create GitHub Discussions Ideas chore(github): Replace feature request as issues with ideas as discussions Sep 13, 2023
@Savio-Sou Savio-Sou added this pull request to the merge queue Sep 13, 2023
Merged via the queue into master with commit e2105f7 Sep 13, 2023
18 checks passed
@Savio-Sou Savio-Sou deleted the ss/github-discussions-contact-link branch September 13, 2023 13:15
@TomAFrench
Copy link
Member

TomAFrench commented Sep 13, 2023

This is a bit of a pain as I can no longer create feature requests issues directly and get pushed towards spamming the discussions page or have to make do without the template.

@Savio-Sou
Copy link
Collaborator Author

Savio-Sou commented Sep 13, 2023

Right, it's a choice of tradeoffs between hosting Feature Requests as:

  1. Issues (previous practice)
    + Can create executable pieces of work directly
    - Unintuitive / deterring for the community

  2. Discussions first, then convert to Issues when executing (as per this PR)
    + Eases community engagement
    + Clear boundary between what is welcoming votes & pending for contribution (Discussions) <> what is already in execution (Issues)
    - 2 additional clicks to create executable pieces of work

  3. Both (1) and (2)
    + Can create executable pieces of work directly
    - Potentially even more confusing than (1):

    • Multiple paths to request feature through "New Issue" (as an Issue or Discussion)
    • Vague status of open Issues: are they welcoming votes or already in execution
    • Mixed voting signals for prioritising works (e.g. are 3 upvotes on Discussion equivalent to 3 thumbs-up on Issue?)

Certainly jumped the gun and assumed (2) gives us the best set of tradeoffs. Would you consider a switch back to (1) is justifiable by the added friction?

Definitely open to adopting an option (4) that achieves the best of both worlds too, suggestions welcome!

github-merge-queue bot pushed a commit that referenced this pull request Jan 25, 2024
… request issues (#4153)

# Description

## Problem\*

The move towards using GitHub Discussions to suggest ideas was found
premature following #2672, as it
introduced additional frictions in:
- Requiring the need to switch between Issues / Discussions to distill
ideas raised
- Discussions are not manageable on GitHub's Project Board

## Summary\*

Until we can formally define how the Ideas section in GitHub Discussions
should be used, this PR reverts the repo back to using GitHub Issues for
feature requests for us to move faster in the meantime.

## Documentation\*

Check one:
- [x] No documentation needed.
- [ ] Documentation included in this PR.
- [ ] **[Exceptional Case]** Documentation to be submitted in a separate
PR.

# PR Checklist\*

- [ ] I have tested the changes locally.
- [x] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants