mirror of
https://github.com/alexgo-io/stacks.js.git
synced 2026-04-28 17:25:51 +08:00
chore: update templates
This commit is contained in:
43
.github/ISSUE_TEMPLATE/bug_report.md
vendored
43
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,47 +1,30 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
labels: 'bug'
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
### What version of Stacks.js are you using?
|
||||
|
||||
**What version of Stacks.js are you using?**
|
||||
<!-- Check if you're using the latest release, and if not let us know which version you are on -->
|
||||
|
||||
**Is the bug present in the Stacks.js CLI, Gaia hub, Connect or Blockstack Browser?**
|
||||
### Describe the bug
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
<!-- Please describe the problem in detail -->
|
||||
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
#### How to reproduce
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
<!-- Help us reproduce the bug, e.g. with a CodeSandbox or example repository showing the problem -->
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
#### Expected behavior
|
||||
|
||||
**Console log**
|
||||
If applicable, add console log to help explain your problem.
|
||||
<!-- If it's unclear, what should be happening instead? -->
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
### Additional context
|
||||
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
- Desktop/Smartphone OS: <!-- e.g. Windows 10, iOS 13.1 -->
|
||||
- Browser <!-- e.g. Chrome 76, Safari 12 -->
|
||||
|
||||
**Smartphone (please complete the following information):**
|
||||
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
<!-- If applicable, add console logs, screenshots, or anything else to help explain the problem -->
|
||||
|
||||
18
.github/ISSUE_TEMPLATE/feature_request.md
vendored
18
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -1,19 +1,19 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
labels: 'feature'
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
### Problem
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
<!-- Is the feature related to a problem? E.g. I'm always frustrated when... -->
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
### Solution
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
<!-- How would you like the problem to be solved? If any ideas come to mind... -->
|
||||
|
||||
### Additional context
|
||||
|
||||
<!-- If applicable, add console logs, screenshots, or anything else to help explain the problem -->
|
||||
|
||||
62
.github/PULL_REQUEST_TEMPLATE.md
vendored
62
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -1,63 +1,23 @@
|
||||
Use the following template to create your pull request
|
||||
### Description
|
||||
|
||||
## Description
|
||||
<!-- Describe the changes made in this PR. Link to any related issues and PRs -->
|
||||
|
||||
Describe the changes that where made in this pull request. When possible start with a user story - short, simple descriptions of a feature told from the perspective of the person who desires the new capability. Be sure to also include the following information:
|
||||
### Type of change
|
||||
|
||||
1. Motivation for change
|
||||
2. What was changed
|
||||
3. How does this impact application developers
|
||||
4. Link to relevant issues and documentation
|
||||
5. Provide examples of use cases with code samples and applicable acceptance criteria
|
||||
|
||||
Example:
|
||||
As a Blockstack developer, I would like to encrypt files using the app private key. This is needed because storing unencrypted files is unacceptable. This pull request adds the `encryptContent` function which will take a string and encrypt it using the app private key.
|
||||
|
||||
```
|
||||
encryptContent('my data')
|
||||
|
||||
// Running the above should result in the following encrypted data object
|
||||
{"iv":"c91...","ephemeralPK":"031...","cipherText":"d61...","mac":"e73..."}
|
||||
```
|
||||
|
||||
For details refer to issue #123
|
||||
|
||||
## Type of Change
|
||||
- [ ] New feature
|
||||
- [ ] Bug fix
|
||||
- [ ] API reference/documentation update
|
||||
- [ ] Documentation update
|
||||
- [ ] Other
|
||||
|
||||
## Does this introduce a breaking change?
|
||||
List the APIs or describe the functionality that this PR breaks.
|
||||
Workarounds for or expected timeline for deprecation
|
||||
### Is this a breaking change?
|
||||
|
||||
## Are documentation updates required?
|
||||
<!--
|
||||
DOCUMENTATION
|
||||
Consider if this PR makes changes that require documentation updates:
|
||||
- API changes
|
||||
- Renamed methods
|
||||
- Change in instructions inside tutorials/guides
|
||||
- etc...
|
||||
<!-- List the APIs or describe the functionality that this PR breaks, as well as related information, e.g. deprecation timline -->
|
||||
|
||||
The best way to find these is by searching inside the docs at https://github.com/blockstack/docs
|
||||
-->
|
||||
- [ ] Link to documentation updates:
|
||||
---
|
||||
|
||||
## Testing information
|
||||
### Checklist
|
||||
|
||||
Provide context on how tests should be performed.
|
||||
- [ ] Unit tested updated code paths
|
||||
- [ ] Tagged 1 of @janniks or @zone117x for review
|
||||
|
||||
1. Is testing required for this change?
|
||||
2. If it’s a bug fix, list steps to reproduce the bug
|
||||
3. Briefly mention affected code paths
|
||||
4. List other affected projects if possible
|
||||
5. Things to watch out for when testing
|
||||
|
||||
## Checklist
|
||||
- [ ] Code is commented where needed
|
||||
- [ ] Unit test coverage for new or modified code paths
|
||||
- [ ] `npm run test` passes
|
||||
- [ ] Changelog is updated
|
||||
- [ ] Tag 1 of @yknl or @zone117x for review
|
||||
<!-- Make sure to run `npm run test` locally to find problems faster -->
|
||||
|
||||
Reference in New Issue
Block a user