Skip to content

Commit d784e17

Browse files
committed
Add GitHub templates.
1 parent 0a66012 commit d784e17

File tree

4 files changed

+107
-0
lines changed

4 files changed

+107
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
** READ THIS FIRST! **
2+
3+
#### Are you looking for help?
4+
5+
Issues should only be filed in this project once they are able to be reproduced
6+
and confirmed as a flaw in the software or incorrect information in associated
7+
documention.
8+
9+
If you are encountering problems integrating this module into your application,
10+
please post a question on the [discussion forum](https://github.com/passport/discuss)
11+
rather than filing an issue.
12+
13+
#### Is this a security issue?
14+
15+
Do not open issues that might have security implications. Potential security
16+
vulnerabilities should be reported privately to [email protected]. Once any
17+
vulerabilities have been repaired, the details will be disclosed publicly in a
18+
responsible manner. This also allows time for coordinating with affected parties
19+
in order to mitigate negative consequences.
20+
21+
22+
<!-- Provide a brief summary of the issue in the title field above. -->
23+
24+
<!-- Provide a detailed description of your use case, including as much -->
25+
<!-- detail as possible about what you are trying to accomplish and why. -->
26+
27+
### Expected behavior
28+
<!-- Provide a detailed description of how you expected the software to -->
29+
<!-- behave. -->
30+
31+
### Actual behavior
32+
<!-- Provide a detailed description of how the software actually behaved, -->
33+
<!-- including any rationale for why that behavior is incorrect. -->
34+
35+
### Steps to reproduce
36+
<!-- Provide an unambiguous series of steps that can be used to reproduce -->
37+
<!-- this issue, including any code if applicable. -->
38+
39+
```js
40+
// Format code using Markdown code blocks
41+
```
42+
43+
### Environment
44+
45+
* Operating System:
46+
* Node version: <!-- $ node -v -->
47+
* passport version: <!-- $ npm list passport -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
** READ THIS FIRST! **
2+
3+
#### Are you implementing a new feature?
4+
5+
Requests for new features should first be discussed on the [discussion forum](https://github.com/passport/discuss).
6+
This allows the community to gather feedback and assess whether or not there is
7+
an existing way to achieve the desired functionality.
8+
9+
If it is determined that a new feature needs to be implemented, include a link
10+
to the relevant discussion along with the pull request.
11+
12+
#### Is this a security patch?
13+
14+
Do not open pull requests that might have security implications. Potential
15+
security vulnerabilities should be reported privately to [email protected].
16+
Once any vulerabilities have been repaired, the details will be disclosed
17+
publicly in a responsible manner. This also allows time for coordinating with
18+
affected parties in order to mitigate negative consequences.
19+
20+
21+
<!-- Provide a brief summary of the request in the title field above. -->
22+
23+
<!-- Provide a detailed description of your use case, including as much -->
24+
<!-- detail as possible about what you are trying to accomplish and why. -->
25+
<!-- If this patch closes an open issue, include a reference to the issue -->
26+
<!-- number. -->
27+
28+
### Checklist
29+
30+
<!-- Place an `x` in the boxes that apply. If you are unsure, please ask and -->
31+
<!-- we will help. -->
32+
33+
- [ ] I have read the [CONTRIBUTING](https://github.com/jaredhanson/passport/blob/master/CONTRIBUTING.md) guidelines.
34+
- [ ] I have added test cases which verify the correct operation of this feature or patch.
35+
- [ ] I have added documentation pertaining to this feature or patch.
36+
- [ ] The automated test suite (`$ make test`) executes successfully.
37+
- [ ] The automated code linting (`$ make lint`) executes successfully.

.npmignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1+
CONTRIBUTING.md
12
Makefile
3+
SPONSORS.md
24
docs/
35
examples/
46
reports/
57
test/
68

9+
.github/
710
.jshintrc
811
.travis.yml

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Contributing
2+
3+
### Tests
4+
5+
The test suite is located in the `test/` directory. All new features are
6+
expected to have corresponding test cases with complete code coverage. Patches
7+
that increase test coverage are happily accepted.
8+
9+
Ensure that the test suite passes by executing:
10+
11+
```bash
12+
$ make test
13+
```
14+
15+
Coverage reports can be generated and viewed by executing:
16+
17+
```bash
18+
$ make test-cov
19+
$ make view-cov
20+
```

0 commit comments

Comments
 (0)