From f99d8a8ff8ae63498a93cbe2bd163cbcd703c4f1 Mon Sep 17 00:00:00 2001 From: Rowan Wookey Date: Tue, 22 Jan 2019 18:07:37 +0000 Subject: [PATCH] Updated README/CONTRIBUTING and github templates closes #13 * Updated README and CONTRIBUTING to explain differences between passport and passport-next #13 @rwky * Updated github templates to reflect passport-next policies --- .github/ISSUE_TEMPLATE.md | 21 ++++----------------- .github/PULL_REQUEST_TEMPLATE.md | 20 ++++---------------- CHANGELOG.md | 6 ++++++ CONTRIBUTING.md | 15 +++++++++++++++ README.md | 30 +++++++++++++++++++++++++++--- 5 files changed, 56 insertions(+), 36 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index a4d33677..d5d67715 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -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 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 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. @@ -44,4 +31,4 @@ in order to mitigate negative consequences. * Operating System: * Node version: -* passport version: +* passport version: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ff6db2bc..31561bff 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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 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 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. @@ -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. diff --git a/CHANGELOG.md b/CHANGELOG.md index b784d81d..e1064ff9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f5639682..4e251e8c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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 diff --git a/README.md b/README.md index beccc9c5..45b91bc4 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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/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