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

infra: auto comment on feature requests #2041

Merged
merged 12 commits into from
Apr 23, 2023
Merged
60 changes: 60 additions & 0 deletions .github/workflows/comment-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Comment Issue

on:
issues:
types:
- labeled
ST-DDT marked this conversation as resolved.
Show resolved Hide resolved

jobs:
add-comment-for-user-interest:
if: "github.event.label.name == 's: waiting for user interest'"
ST-DDT marked this conversation as resolved.
Show resolved Hide resolved
runs-on: ubuntu-latest
permissions:
issues: write
steps:
- name: Add Comment For User Interest
uses: actions/github-script@v6
with:
script: |
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: `**Thank you for your feature proposal.**

We marked it as "waiting for user interest" for now to gather some feedback from our community:

- If you would like to see this feature be implemented, please react to the description with an up-vote (:+1:).
- If you have a suggestion or want to point out some special cases that need to be considered, please leave a comment, so we are aware about them.

We would also like to hear about other community members' use cases for the feature to give us a better understanding of their potential implicit or explicit requirements.

We will start the implementation based on:

- the number of votes (:+1:) and comments
- the relevance for the ecosystem
- availability of alternatives and workarounds
- and the complexity of the requested feature

We do this because:

- There are plenty of languages/countries out there and we would like to ensure that every method can cover all or almost all of them.
- Every feature we add to faker has "costs" associated to it:
- initial costs: design, implementation, reviews, documentation
- running costs: awareness of the feature itself, more complex module structure, increased bundle size, more work during refactors

---

[View more issues which are waiting for user interest](https://github.com/faker-js/faker/issues?q=is%3Aissue+is%3Aopen+label%3A%22s%3A+waiting+for+user+interest%22+)`,
ST-DDT marked this conversation as resolved.
Show resolved Hide resolved
})

- name: React to Issue
uses: actions/github-script@v6
with:
script: |
github.rest.reactions.createForIssue({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
content: "+1",
});