Skip to content

Commit 45cca5f

Browse files
CharlieC3zone117x
authored andcommitted
chore: add more robust pr template
1 parent 10ce5ac commit 45cca5f

File tree

2 files changed

+63
-11
lines changed

2 files changed

+63
-11
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
Use the following template to create your pull request
2+
3+
## Description
4+
5+
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:
6+
7+
1. Motivation for change
8+
2. What was changed
9+
3. How does this impact application developers
10+
4. Link to relevant issues and documentation
11+
5. Provide examples of use cases with code samples and applicable acceptance criteria
12+
13+
Example:
14+
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.
15+
16+
```
17+
encryptContent('my data')
18+
19+
// Running the above should result in the following encrypted data object
20+
{"iv":"c91...","ephemeralPK":"031...","cipherText":"d61...","mac":"e73..."}
21+
```
22+
23+
For details refer to issue #123
24+
25+
## Type of Change
26+
- [ ] New feature
27+
- [ ] Bug fix
28+
- [ ] API reference/documentation update
29+
- [ ] Other
30+
31+
## Does this introduce a breaking change?
32+
List the APIs or describe the functionality that this PR breaks.
33+
Workarounds for or expected timeline for deprecation
34+
35+
## Are documentation updates required?
36+
<!--
37+
DOCUMENTATION
38+
Consider if this PR makes changes that require documentation updates:
39+
- API changes
40+
- Renamed methods
41+
- Change in instructions inside tutorials/guides
42+
- etc...
43+
44+
The best way to find these is by searching inside the docs at https://github.com/blockstack/docs
45+
-->
46+
- [ ] Link to documentation updates:
47+
48+
## Testing information
49+
50+
Provide context on how tests should be performed.
51+
52+
1. Is testing required for this change?
53+
2. If it’s a bug fix, list steps to reproduce the bug
54+
3. Briefly mention affected code paths
55+
4. List other affected projects if possible
56+
5. Things to watch out for when testing
57+
58+
## Checklist
59+
- [ ] Code is commented where needed
60+
- [ ] Unit test coverage for new or modified code paths
61+
- [ ] `npm run test` passes
62+
- [ ] Changelog is updated
63+
- [ ] Tag 1 of @kyranjamie or @zone117x for review

.github/pull_request_template.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)