Skip to content

Commit

Permalink
Updated README/CONTRIBUTING and github templates closes #13
Browse files Browse the repository at this point in the history
* Updated README and CONTRIBUTING to explain differences between passport and passport-next #13 @rwky
* Updated github templates to reflect passport-next policies
  • Loading branch information
rwky committed Jan 22, 2019
1 parent c07b60a commit f99d8a8
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 36 deletions.
21 changes: 4 additions & 17 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,10 @@
** READ THIS FIRST! **

#### Are you looking for help?

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 [email protected]. 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 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. -->

Expand All @@ -44,4 +31,4 @@ in order to mitigate negative consequences.

* Operating System:
* Node version: <!-- $ node -v -->
* passport version: <!-- $ npm list passport -->
* passport version: <!-- $ npm list @passport-next/passport -->
20 changes: 4 additions & 16 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,10 @@
** READ THIS FIRST! **

#### Are you implementing a new feature?

Requests for new features should first be discussed on the [discussion forum](https://github.com/passport/discuss).
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 [email protected].
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 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 request in the title field above. -->

Expand All @@ -34,4 +22,4 @@ affected parties in order to mitigate negative consequences.
- [ ] 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.
- [ ] The automated code linting (`$ npm run-script lint`) executes successfully.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
This changelog follows Semantic Versioning https://semver.org/

# Unreleased

* Added gitlab sast testing @rwky
* Updated npm dev deps @rwky
* Updated README and CONTRIBUTING to explain differences between passport and passport-next #13 @rwky

# 2.1.0 (2018-11-03)

* Exposed the method to customize the SessionManager object @adamhathcock
Expand Down
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
## Contributing

Pull Requests are welcome for any issues, if you have any questions please
[raise an issue](https://github.com/passport-next/passport/issues).

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.

If you wish to join the team please raise an issue and one of the maintainers will assess your
request.

### Tests

The test suite is located in the `test/` directory. All new features are
Expand All @@ -12,6 +22,11 @@ Ensure that the test suite passes by executing:
$ make test
```

Ensure that lint passes
```bash
$ npm run-script lint
```

Coverage reports can be generated and viewed by executing:

```bash
Expand Down
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Passport
# Passport-Next/Passport

Passport is [Express](http://expressjs.com/)-compatible authentication
Passport-Next/Passport is [Express](http://expressjs.com/)-compatible authentication
middleware for [Node.js](http://nodejs.org/).

Passport's sole purpose is to authenticate requests, which it does through an
Expand All @@ -16,7 +16,31 @@ Status:
[![Coverage Status](https://coveralls.io/repos/github/passport-next/passport/badge.svg?branch=master)](https://coveralls.io/github/passport-next/passport?branch=master)
[![Maintainability](https://api.codeclimate.com/v1/badges/deaf381bf0cff6bf26a5/maintainability)](https://codeclimate.com/github/passport-next/passport/maintainability)
[![Dependencies](https://david-dm.org/passport-next/passport.png)](https://david-dm.org/passport-next/passport)
<!--[![SAST](https://gitlab.com/passport-next/passport-strategy/badges/master/build.svg)](https://gitlab.com/passport-next/passport-strategy/badges/master/build.svg)-->
[![SAST](https://gitlab.com/passport-next/passport/badges/master/build.svg)](https://gitlab.com/passport-next/passport/badges/master/build.svg)


## Differences between passport and passport-next

[Passport Next](https://github.com/passport-next) was created as a fork of the Passport repositories
when the upstream repositories became stale and stopped working due to changes at the various
authentication providers (e.g. Facebook API deprecation, Tumblr using HTTPS etc.)

Passport Next aims to:

* Keep the modules up to date with the various authentication providers
* Maintain up to date dependencies
* Address any security issues promptly
* Ensure compatibility with the current [supported versions](https://github.com/nodejs/Release) of Node
* Maintain the repositories in an organisation so maintaining isn't the responsibility of one person
* Follow [Semantic Versioning](https://semver.org/)
* Keep an up to date CHANGELOG.md

**Passport Next does not aim to be backwards compatible with the upstream repositories.
The changes required to keep up to date and functioning prohibit that so if you're migrating
from the upstream modules please test your code thouroughly!**

If you wish to join the team please raise an issue and one of the maintainers will assess your
request.

## Install

Expand Down

0 comments on commit f99d8a8

Please sign in to comment.