A template for open source projects at Auth0 [WIP]
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Tech-specific dirs; minor tweaks to template docs Nov 6, 2018
javascript
php
python
ruby
.gitignore
CHANGELOG.md
CODE-OF-CONDUCT.md
CONTRIBUTING.md
GENERAL-CONTRIBUTING.md
LICENSE
README-sample.md
README.md
codecov.yml
example.env

README.md

Auth0 Open Source Template

This repo contains sample files to be used in Auth0 open source software repositories. These files are guidelines that can be used in an Auth0 or any open source project to ensure that the project is described properly, the contribution process is clear, and additional tools like CI, coverage monitors, and quality checkers are configured properly.

Table of Contents

Getting Started

This repo can be cloned, modified, then re-purposed for new open source projects. It can also be used piecemeal to improve existing repos.

Copy README-sample.md to README.md

The core of open source repo quality is the README.md file that's displayed on the repo's homepage in Github. The README-sample.md included here was collaboratively created by Auth0's SDK engineering team and community engineering team based on samples of high-quality README files around the web.

Most sections within this file should be considered required, even if that section contains a link to a more relevant page. Certain sections will contain repo-specific information and should be modified as needed:

  • Description (below the title)
  • Badges
  • Documentation
  • Installation
  • Getting Started
  • Thank you
  • License

Other sections should be used as-is with minimal changes:

  • Table of Contents
  • Contribution
  • Support + Feedback
  • Vulnerability Reporting
  • What is Auth0?

Modify templates in .github

The issue and PR templates contained in this repo are general guidelines for what to include. What is being asked for is entirely up to the repo maintainer but a template of some kind should be included.

Update LICENSE

See README-sample.md for guidelines.

Modify .gitignore

This file contains files that will be excluded from git. Modify as needed based on the technology being used.

Modify/remove platform-specific files

Additional template files have been included here for the specific technology that we work with. These should be considered as guidelines and not enforced in any way.

Contribution

We appreciate feedback and contribution to this template! Before you get started, please see the following:

Thank You!

A big thank you to all of our sources of inspiration!

... and many more!

License

This repo is covered under The MIT License.