Skip to content

Commit

Permalink
chore: create issue forms and a PR template (#65)
Browse files Browse the repository at this point in the history
* chore: create issue forms and a PR template

* Use Renovate Approve Bot in text
  • Loading branch information
HonkingGoose authored Aug 24, 2022
1 parent 78e9095 commit 41467c4
Show file tree
Hide file tree
Showing 6 changed files with 108 additions and 2 deletions.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Bug report
description: Report a bug.
labels: ['type:bug', 'status:requirements', 'priority-5-triage']
body:
- type: input
id: version-of-renovate-approve-bot
attributes:
label: Version.
description: What version of the Renovate Approve Bot are you using?
validations:
required: true

- type: textarea
id: describe-bug
attributes:
label: Describe the bug.
description: 'Do not report any security concerns here. Email [[email protected]](mailto:[email protected]) instead.'
validations:
required: true

- type: textarea
id: relevant-logs
attributes:
label: Relevant logs/debug messages.
description: |
Copy/paste any relevant logs or debug messages in this field.
value: |
<details><summary>Logs</summary>
```
Copy/paste any log here, between the starting and ending backticks
```
</details>
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Feature request
description: Suggest an idea for this project.
labels: ['type:feature', 'status:requirements', 'priority-5-triage']
body:
- type: textarea
id: what-would-you-like-renovate-approve-bot-to-be-able-to-do
attributes:
label: What would you like the Renovate Approve Bot to be able to do?
placeholder: "Tell us what requirements you need solving, and be sure to mention too if this is part of any bigger problem you're trying to solve."
validations:
required: true

- type: textarea
id: implementation-idea-textbox
attributes:
label: If you have any ideas on how this should be implemented, please tell us here.
placeholder: "In case you've already dug into existing options or source code and have ideas, mention them here. Try to keep implementation ideas separate from requirements."
validations:
required: true

- type: dropdown
id: interested-in-implementing-the-feature
attributes:
label: Is this a feature you are interested in implementing yourself?
options:
- 'Yes'
- 'No'
validations:
required: true
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/refactor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Refactor (internal)
description: For internal use only.
labels: ['type:refactor', 'status:requirements', 'priority-5-triage']
body:
- type: textarea
id: describe-the-proposed-refactor
attributes:
label: Describe the proposed refactor.
description: 'Do not report any security concerns here. Email [[email protected]](mailto:[email protected]) instead.'
validations:
required: true
29 changes: 29 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!-- Make sure the `Allow edits and access to secrets by maintainers` checkbox is checked on this pull request. -->

## Changes:

<!-- Describe what behavior is changed by this PR. -->

## Context:

<!-- Describe why you're making these changes if it's not already explained in a corresponding issue. -->
<!-- If you're closing an existing issue with this pull request, use the keyword Closes #issue_number -->

## Documentation (please check one with an [x])

- [ ] I have updated the documentation, or
- [ ] No documentation update is required

## How I've tested my work (please tick one)

I have verified these changes via:

- [ ] Code inspection only, or
- [ ] Newly added/modified unit tests, or
- [ ] No unit tests but ran on a real repository, or
- [ ] Both unit tests + ran on a real repository

<!-- Do you have any suggestions about this PR template? Edit it here: https://github.com/renovatebot/renovate-approve-bot-bitbucket-cloud/edit/main/.github/pull_request_template.md -->

<!-- Please do not force push to your PR's branch after you have created your PR, as doing so forces us to review the whole PR again. This makes it harder for us to review your work because we don't know what has changed. -->
<!-- PRs will always be squashed by us when we merge your work. Commit as many times as you need in this branch. -->
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
"jest": "jest",
"lint": "run-s eslint prettier",
"lint-fix": "run-s eslint-fix prettier-fix",
"prettier": "prettier --check \"**/*.{js,json,md}\"",
"prettier-fix": "prettier --write \"**/*.{js,json,md}\"",
"prettier": "prettier --check \"**/*.{js,json,md,yml}\"",
"prettier-fix": "prettier --write \"**/*.{js,json,md,yml}\"",
"start": "node ./index.js",
"test": "run-s lint jest"
},
Expand Down

0 comments on commit 41467c4

Please sign in to comment.