Skip to content

Commit

Permalink
Updated .github templates
Browse files Browse the repository at this point in the history
  • Loading branch information
rwky committed Jun 18, 2019
1 parent d0d7f2a commit f481bd4
Show file tree
Hide file tree
Showing 13 changed files with 100 additions and 21 deletions.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Bug Report
about: Report a bug
title: ''
labels: bug
assignees: ''
---

# READ THIS FIRST!

#### Is this a security issue?

If you discover a security issue please create an issue stating you've discovered a security
issue but don't divulge the issue, one of the maintainers will respond with an email address
you can send the details to. Once the issue has been patched the details can be made public.

<!-- 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-next/passport -->
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Feature Request
about: Report a new feature
title: ''
labels: enhancement
assignees: ''
---

# READ THIS FIRST!

#### Is this a security issue?

If you discover a security issue please create an issue stating you've discovered a security
issue but don't divulge the issue, one of the maintainers will respond with an email address
you can send the details to. Once the issue has been patched the details can be made public.

<!-- Provide a brief summary of the feature 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. -->

### Environment

* Operating System:
* Node version: <!-- $ node -v -->
* passport version: <!-- $ npm list @passport-next/passport -->
8 changes: 8 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## Need help?

Please raise an [issue](https://github.com/passport-next/skel/issues) and/or ask a question on [Stackoverflow](https://stackoverflow.com) with the `passport.js` tag.

## Support policy

We support all [node versions](https://github.com/nodejs/Release) supported by the Node Foundation

4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
This changelog follows Semantic Versioning https://semver.org/

# 1.0.3 (2019-06-18)

* Updated .github templates

# 1.0.2 (2019-06-18)

### Patch
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Please raise an [issue](https://github.com/passport-next/skel/issues) and/or ask
We support all [node versions](https://github.com/nodejs/Release) supported by the Node Foundation



## Contributing

Please see [CONTRIBUTING.md](https://github.com/passport-next/skel/blob/master/CONTRIBUTING.md)
Expand Down
3 changes: 3 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
If you discover a security issue please create an issue stating you've discovered a security
issue but don't divulge the issue, one of the maintainers will respond with an email address
you can send the details to. Once the issue has been patched the details can be made public.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@passport-next/skel",
"version": "1.0.2",
"version": "1.0.3",
"description": "Passport next project skeleton",
"author": {
"name": "Passport Next Developers",
Expand Down
5 changes: 1 addition & 4 deletions templates/.github/ISSUE_TEMPLATE/bug_report.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,7 @@ assignees: ''

#### Is this a security issue?

If you discover a security issue please create an issue stating you've discovered a security
issue but don't divulge the issue, one of the maintainers will respond with an email address
you can send the details to. Once the issue has been patched the details can be made public.

{% include "../../SECURITY.md.j2" %}
<!-- Provide a brief summary of the issue in the title field above. -->

<!-- Provide a detailed description of your use case, including as much -->
Expand Down
5 changes: 1 addition & 4 deletions templates/.github/ISSUE_TEMPLATE/feature_request.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,7 @@ assignees: ''

#### Is this a security issue?

If you discover a security issue please create an issue stating you've discovered a security
issue but don't divulge the issue, one of the maintainers will respond with an email address
you can send the details to. Once the issue has been patched the details can be made public.

{% include "../../SECURITY.md.j2" %}
<!-- Provide a brief summary of the feature in the title field above. -->

<!-- Provide a detailed description of your use case, including as much -->
Expand Down
5 changes: 1 addition & 4 deletions templates/.github/PULL_REQUEST_TEMPLATE.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,7 @@

#### Is this a security patch?

If you discover a security issue please create an issue stating you've discovered a security
issue but don't divulge the issue, one of the maintainers will respond with an email address
you can send the details to. Once the issue has been patched the details can be made public.

{% include "../SECURITY.md.j2" %}
<!-- Provide a brief summary of the request in the title field above. -->

<!-- Provide a detailed description of your use case, including as much -->
Expand Down
8 changes: 8 additions & 0 deletions templates/.github/SUPPORT.md.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## Need help?

Please raise an [issue]({{github}}/issues) and/or ask a question on [Stackoverflow](https://stackoverflow.com) with the `passport.js` tag.

## Support policy

We support all [node versions](https://github.com/nodejs/Release) supported by the Node Foundation

9 changes: 1 addition & 8 deletions templates/README.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,8 @@ $ npm install {{npmModule}}

[Please see the wiki]({{github}}/wiki)

## Need help?

Please raise an [issue]({{github}}/issues) and/or ask a question on [Stackoverflow](https://stackoverflow.com) with the `passport.js` tag.

## Support policy

We support all [node versions](https://github.com/nodejs/Release) supported by the Node Foundation
{% include "./.github/SUPPORT.md.j2" %}
{% include "./includes/support.j2" %}

## Contributing

Please see [CONTRIBUTING.md]({{github}}/blob/master/CONTRIBUTING.md)
Expand Down
3 changes: 3 additions & 0 deletions templates/SECURITY.md.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
If you discover a security issue please create an issue stating you've discovered a security
issue but don't divulge the issue, one of the maintainers will respond with an email address
you can send the details to. Once the issue has been patched the details can be made public.

0 comments on commit f481bd4

Please sign in to comment.