aboutsummaryrefslogtreecommitdiff
path: root/.github/workflows
diff options
context:
space:
mode:
authorDivisionByZero <[email protected]>2023-04-23 09:01:28 +0200
committerGitHub <[email protected]>2023-04-23 09:01:28 +0200
commitf795269c3aa2014c4964ea71c38b53a51e0f6d47 (patch)
tree5d3f671858b90604c12532a6a199d85e8e56a9ec /.github/workflows
parent8fc5261298ebd0dfe616fed9265ce9d7e626ae96 (diff)
downloadfaker-f795269c3aa2014c4964ea71c38b53a51e0f6d47.tar.xz
faker-f795269c3aa2014c4964ea71c38b53a51e0f6d47.zip
infra: auto comment on feature requests (#2041)
Diffstat (limited to '.github/workflows')
-rw-r--r--.github/workflows/comment-issue.yml60
1 files changed, 60 insertions, 0 deletions
diff --git a/.github/workflows/comment-issue.yml b/.github/workflows/comment-issue.yml
new file mode 100644
index 00000000..c9d33ce4
--- /dev/null
+++ b/.github/workflows/comment-issue.yml
@@ -0,0 +1,60 @@
+name: Comment Issue
+
+on:
+ issues:
+ types:
+ - labeled
+
+jobs:
+ add-comment-for-user-interest:
+ if: "github.event.label.name == 's: waiting for user interest'"
+ 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+)`,
+ })
+
+ - 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",
+ });