diff options
| author | Shinigami <[email protected]> | 2022-01-09 21:45:30 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2022-01-09 15:45:30 -0500 |
| commit | 0c8506faf1c2fe4d74cab33d9244e34e40b23711 (patch) | |
| tree | d80c8603bb142da07623f88637d1967fd5f57939 | |
| parent | 7b0558edab05b7440cb36f920abbf78037b13c8a (diff) | |
| download | faker-0c8506faf1c2fe4d74cab33d9244e34e40b23711.tar.xz faker-0c8506faf1c2fe4d74cab33d9244e34e40b23711.zip | |
chore(ci): automated issue labeling and issue templates (#41)
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.yml | 31 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/config.yml | 8 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.yml | 31 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/freestyle.md | 5 | ||||
| -rw-r--r-- | .github/workflows/issue-labeling.yml | 32 |
5 files changed, 107 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..2f0dffd8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,31 @@ +name: "\U0001F41E Bug report" +description: Report an issue +labels: [pending triage] # This will automatically assign the 'pending triage' label +body: + - type: markdown + attributes: + value: Thanks for taking the time to fill out this bug report! + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks! + placeholder: Bug description + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction + description: Please reproduce the problem you ran into. + placeholder: Reproduction + validations: + required: true + - type: textarea + id: additional-info + attributes: + label: Additional Info + description: Give us additional info like e.g. version numbers. + placeholder: Additional info + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..313e0995 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Discord Chat + url: discord.gg/4qDjAmDj4P + about: Ask questions and discuss with other users in real time. + - name: Questions & Discussions + url: https://github.com/faker-js/faker.js/discussions + about: Use GitHub discussions for message-board style questions and discussions. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..86d0cf78 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,31 @@ +name: "\U0001F680 New feature proposal" +description: Propose a new feature +labels: ["pending triage"] # This will automatically assign the 'pending triage' label +body: + - type: markdown + attributes: + value: Thanks for your interest in the project and taking the time to fill out this feature report! + - type: textarea + id: feature-description + attributes: + label: Clear and concise description of the problem + description: "As a developer using faker I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!" + validations: + required: true + - type: textarea + id: suggested-solution + attributes: + label: Suggested solution + description: "In module [xy] we could provide following implementation..." + validations: + required: true + - type: textarea + id: alternative + attributes: + label: Alternative + description: Clear and concise description of any alternative solutions or features you've considered. + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Any other context about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/freestyle.md b/.github/ISSUE_TEMPLATE/freestyle.md new file mode 100644 index 00000000..9bde1ad0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/freestyle.md @@ -0,0 +1,5 @@ +--- +name: Freestyle Report +about: Create a report to help us improve +labels: "pending triage" # This will automatically assign the 'pending triage' label +--- diff --git a/.github/workflows/issue-labeling.yml b/.github/workflows/issue-labeling.yml new file mode 100644 index 00000000..a9bbaaac --- /dev/null +++ b/.github/workflows/issue-labeling.yml @@ -0,0 +1,32 @@ +name: Issue Labeling + +on: + issues: + types: [labeled] + +jobs: + reply-labeled: + runs-on: ubuntu-latest + steps: + - name: contribution welcome + # If the issue is labeled with 'help wanted', a comment will be posted + if: github.event.label.name == 'help wanted' + uses: actions-cool/issues-helper@v2 + with: + actions: "create-comment, remove-labels" + token: ${{ secrets.GITHUB_TOKEN }} + issue-number: ${{ github.event.issue.number }} + body: | + Hello @${{ github.event.issue.user.login }}. We like your proposal/feedback and would appreciate a contribution via a Pull Request by you or another community member. We thank you in advance for your contribution and are looking forward to reviewing it! + labels: "pending triage" + + - name: remove pending + # If the issue is given either the 'enhancement' or 'bug' label, the 'pending triage' label will be removed + # Issues without the label 'pending triage' are filtered with the third part of the condition, since the label does not have to be removed + if: github.event.label.name == 'enhancement' || github.event.label.name == 'bug' || (contains(github.event.label.name, 'pending triage') == false) + uses: actions-cool/issues-helper@v2 + with: + actions: "remove-labels" + token: ${{ secrets.GITHUB_TOKEN }} + issue-number: ${{ github.event.issue.number }} + labels: "pending triage" |
