Skip to content

Commit

Permalink
add github templates for more detailed issues and PRs
Browse files Browse the repository at this point in the history
  • Loading branch information
pacrob committed Apr 5, 2024
1 parent 9183531 commit 5defff9
Show file tree
Hide file tree
Showing 4 changed files with 103 additions and 0 deletions.
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: Bug Report
description: File a bug report
labels: ["bug"]
body:
- type: markdown
attributes:
value: "## What was wrong"
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us what you expected to happen
validations:
required: true
- type: textarea
id: code-that-caused
attributes:
label: Code that produced the error
description: Formats to Python, no backticks needed
render: python
validations:
required: false
- type: textarea
id: error-output
attributes:
label: Full error output
description: Formats to shell, no backticks needed
render: shell
validations:
required: false
- type: markdown
attributes:
value: "## Potential Solutions"
- type: textarea
id: how-to-fix
attributes:
label: Fill this section in if you know how this could or should be fixed
description: Include any relevant examples or reference material
validations:
required: false
- type: input
id: lib-version
attributes:
label: blake2b-py Version
description: Which version of blake2b-py are you using?
placeholder: x.x.x
validations:
required: false
- type: input
id: py-version
attributes:
label: Python Version
description: Which version of Python are you using?
placeholder: x.x.x
validations:
required: false
- type: input
id: os
attributes:
label: Operating System
description: Which operating system are you using?
placeholder: osx/linux/win
validations:
required: false
- type: textarea
id: pip-freeze
attributes:
label: Output from `pip freeze`
description: Run `python -m pip freeze` and paste the output below
render: shell
validations:
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Questions about using blake2b-py?
url: https://discord.gg/GHryRvPB84
about: You can ask and answer usage questions on the Ethereum Python Community Discord
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Feature Request
description: Request a new feature
labels: ["feature_request"]
body:
- type: textarea
id: feature-description
attributes:
label: What feature should we add?
description: Include any relevant examples or reference material
validations:
required: true
15 changes: 15 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### What was wrong?

Related to Issue #
Closes #

### How was it fixed?

### Todo:

- [ ] Clean up commit history
- [ ] Add or update documentation related to these changes

#### Cute Animal Picture

![Put a link to a cute animal picture inside the parenthesis-->](<>)

0 comments on commit 5defff9

Please sign in to comment.