📝 GitHub settings

Added templates
This commit is contained in:
Pasha8914 2022-04-22 15:58:57 +10:00 committed by Danil Kovtonyuk
parent cdcb426872
commit 37753af5c9
4 changed files with 163 additions and 0 deletions

12
.github/CONTRIBUTING.md vendored Normal file

@ -0,0 +1,12 @@
# Welcome to TornadoCash!
If you're submitting code to TornadoCash, there are some simple things we'd appreciate you doing to help us stay organized!
### Finding the right project
Before taking the time to code and implement something, feel free to open an issue and discuss it! There may even be an issue already open, and together we may come up with a specific strategy before you take your precious time to write code.
### Submitting a pull request
Please try not to include multiple features in a single PR, and don't make extraneous changes outside the scope of your contribution. All those touched files make things harder to review.
And that's it! Thanks for helping out.

103
.github/ISSUE_TEMPLATE/bug-report.yaml vendored Normal file

@ -0,0 +1,103 @@
name: Bug Report
description: Using TornadoCash, but it's not working as you expect?
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
## **Before Submitting:**
* Save your note, clear your cache, use a different connection or VPN, and try again.
* If the error persists reach out to [customer support](https://discord.com/invite/TFDrM8K42j).
* Please search to make sure this issue has not been opened already.
- type: textarea
id: what-happened
attributes:
label: Describe the bug
description: What happened? What did you expect to happen? Please include screenshots if applicable!
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce
description: List all steps needed to reproduce the problem
value: |
1.
validations:
required: true
- type: textarea
id: error
attributes:
label: Error messages or log output
description: Please copy and paste any relevant error messages or log output. This will be automatically formatted, so there is no need for backticks.
render: shell
- type: input
id: source
attributes:
label: Source
description: What gateway are you using?
- type: input
id: wallet
attributes:
label: Wallet
description: What wallet and which version are you running?
validations:
required: true
- type: input
id: version
attributes:
label: TornadoCash version
description: Which version of TornadoCash are you running ?
validations:
required: true
- type: dropdown
id: browsers
attributes:
label: Browser
description: Which browsers have you seen the problem on?
multiple: true
options:
- Chrome
- Firefox
- Microsoft Edge
- Brave
- TOR
- Other (please elaborate in the "Additional Context" section)
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating system
description: Which operating systems have you seen the problem on?
multiple: true
options:
- Windows
- MacOS
- Linux
- Other (please elaborate in the "Additional Context" section)
validations:
required: true
- type: dropdown
id: hardware-wallet
attributes:
label: Hardware wallet
description: Are you using any of these hardware wallets? Please include the firmware version in the "Additional context" section below for any that you select here.
multiple: true
options:
- Ledger
- Trezor
- Keystone
- GridPlus Lattice1
- AirGap Vault
- Other (please elaborate in the "Additional Context" section)
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here, e.g. related issues, additional error messages or logs, or any potentially relevant details about the environment or situation the bug occurred in.

8
.github/ISSUE_TEMPLATE/config.yaml vendored Normal file

@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Request a new feature
url: https://torn.community/
about: Request new features and vote on the ones that are important to you.
- name: Get support or ask a question
url: https://discord.com/invite/TFDrM8K42j
about: Join Discord community server to get help and ask questions

40
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file

@ -0,0 +1,40 @@
## Explanation
<!--
Thanks for the pull request. Take a moment to answer these questions so that reviewers have the information they need to properly understand your changes:
* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
Below is a template to give you some ideas. Feel free to use your own words!
Currently, ...
This is a problem because ...
In order to solve this problem, this pull request ...
-->
## More information
<!--
Are there any issues, [community forum](https://torn.community/) discussion, user stories, etc. reviewers should consult to understand this pull request better? For instance:
* Fixes #12345
* See: #67890
-->
## Screenshots/Screencaps
<!-- If you're making a change to the UI, make sure to capture a screenshot or a short video showing off your work! -->
### Before
<!-- How did the UI you changed look before your changes? Drag your file(s) below this line: -->
### After
<!-- How does it look now? Drag your file(s) below this line: -->
## Manual testing steps
<!--
How should reviewers and QA manually test your changes? For instance:
- Go to this screen
- Do this
- Then do this
-->