mirror of
https://github.com/hanzoai/passport-local.git
synced 2026-09-23 23:48:22 +00:00
Add GitHub templates.
This commit is contained in:
@@ -0,0 +1,54 @@
|
|||||||
|
** READ THIS FIRST! **
|
||||||
|
|
||||||
|
#### Are you looking for help?
|
||||||
|
|
||||||
|
Reminder: The issue tracker is not a support forum.
|
||||||
|
|
||||||
|
Issues should only be filed in this project once they are able to be reproduced
|
||||||
|
and confirmed as a flaw in the software or incorrect information in associated
|
||||||
|
documention.
|
||||||
|
|
||||||
|
If you are encountering problems integrating this module into your application,
|
||||||
|
please post a question on the [discussion forum](https://github.com/passport/discuss)
|
||||||
|
rather than filing an issue.
|
||||||
|
|
||||||
|
#### Is this a security issue?
|
||||||
|
|
||||||
|
Do not open issues that might have security implications. Potential security
|
||||||
|
vulnerabilities should be reported privately to jaredhanson@gmail.com. Once any
|
||||||
|
vulerabilities have been repaired, the details will be disclosed publicly in a
|
||||||
|
responsible manner. This also allows time for coordinating with affected parties
|
||||||
|
in order to mitigate negative consequences.
|
||||||
|
|
||||||
|
|
||||||
|
If neither of the above two scenarios apply to your situation, you should open
|
||||||
|
an issue. Delete this paragraph and the text above, and fill in the information
|
||||||
|
requested below.
|
||||||
|
|
||||||
|
<!-- Provide a brief summary of the issue in the title field above. -->
|
||||||
|
|
||||||
|
<!-- Provide a detailed description of your use case, including as much -->
|
||||||
|
<!-- detail as possible about what you are trying to accomplish and why. -->
|
||||||
|
|
||||||
|
### Expected behavior
|
||||||
|
<!-- Provide a detailed description of how you expected the software to -->
|
||||||
|
<!-- behave. -->
|
||||||
|
|
||||||
|
### Actual behavior
|
||||||
|
<!-- Provide a detailed description of how the software actually behaved, -->
|
||||||
|
<!-- including any rationale for why that behavior is incorrect. -->
|
||||||
|
|
||||||
|
### Steps to reproduce
|
||||||
|
<!-- Provide an unambiguous series of steps that can be used to reproduce -->
|
||||||
|
<!-- this issue, including any code if applicable. -->
|
||||||
|
|
||||||
|
```js
|
||||||
|
// Format code using Markdown code blocks
|
||||||
|
```
|
||||||
|
|
||||||
|
### Environment
|
||||||
|
|
||||||
|
* Operating System:
|
||||||
|
* Node version: <!-- $ node -v -->
|
||||||
|
* passport version: <!-- $ npm list passport -->
|
||||||
|
* passport-local version: <!-- $ npm list passport-local -->
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
** READ THIS FIRST! **
|
||||||
|
|
||||||
|
#### Are you implementing a new feature?
|
||||||
|
|
||||||
|
Requests for new features should first be discussed on the [developer forum](https://github.com/passport/develop).
|
||||||
|
This allows the community to gather feedback and assess whether or not there is
|
||||||
|
an existing way to achieve the desired functionality.
|
||||||
|
|
||||||
|
If it is determined that a new feature needs to be implemented, include a link
|
||||||
|
to the relevant discussion along with the pull request.
|
||||||
|
|
||||||
|
#### Is this a security patch?
|
||||||
|
|
||||||
|
Do not open pull requests that might have security implications. Potential
|
||||||
|
security vulnerabilities should be reported privately to jaredhanson@gmail.com.
|
||||||
|
Once any vulerabilities have been repaired, the details will be disclosed
|
||||||
|
publicly in a responsible manner. This also allows time for coordinating with
|
||||||
|
affected parties in order to mitigate negative consequences.
|
||||||
|
|
||||||
|
|
||||||
|
If neither of the above two scenarios apply to your situation, you should open
|
||||||
|
a pull request. Delete this paragraph and the text above, and fill in the
|
||||||
|
information requested below.
|
||||||
|
|
||||||
|
<!-- Provide a brief summary of the request in the title field above. -->
|
||||||
|
|
||||||
|
<!-- Provide a detailed description of your use case, including as much -->
|
||||||
|
<!-- detail as possible about what you are trying to accomplish and why. -->
|
||||||
|
<!-- If this patch closes an open issue, include a reference to the issue -->
|
||||||
|
<!-- number. -->
|
||||||
|
|
||||||
|
### Checklist
|
||||||
|
|
||||||
|
<!-- Place an `x` in the boxes that apply. If you are unsure, please ask and -->
|
||||||
|
<!-- we will help. -->
|
||||||
|
|
||||||
|
- [ ] I have read the [CONTRIBUTING](https://github.com/jaredhanson/passport-local/blob/master/CONTRIBUTING.md) guidelines.
|
||||||
|
- [ ] I have added test cases which verify the correct operation of this feature or patch.
|
||||||
|
- [ ] I have added documentation pertaining to this feature or patch.
|
||||||
|
- [ ] The automated test suite (`$ make test`) executes successfully.
|
||||||
|
- [ ] The automated code linting (`$ make lint`) executes successfully.
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
## Contributing
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
|
||||||
|
The test suite is located in the `test/` directory. All new features are
|
||||||
|
expected to have corresponding test cases with complete code coverage. Patches
|
||||||
|
that increase test coverage are happily accepted.
|
||||||
|
|
||||||
|
Ensure that the test suite passes by executing:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ make test
|
||||||
|
```
|
||||||
|
|
||||||
|
Coverage reports can be generated and viewed by executing:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ make test-cov
|
||||||
|
$ make view-cov
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user