Contribution guidelines

Butler Auth is developed in Node.js, with support from various NPM modules.
Specifically, most authentication providers are implemented using Passport.js.

We use Hugo to format and generate this documentation site and the Docsy theme for styling and site structure.
Hugo is an open-source static site generator that provides us with templates, content organisation in a standard directory structure, and a website generation engine. You write the pages in Markdown (or HTML if you want), and Hugo wraps them up into a website.

All submissions, including submissions by project members, require review.
We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Discussions

We use GitHub’s discussion boards to discuss ideas, features, issues and everything else relating to Butler Auth.

Contributing to Butler Auth and this documentation site

Butler Auth itself lives in https://github.com/ptarmiganlabs/butler-auth.

The doc site lives in https://github.com/ptarmiganlabs/butler-auth-docs.

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Test your changes

As obvious as it might sound: Please test your proposed changes properly before submitting pull requests.

Creating an issue

If you’ve found a problem - or have a feature suggestion - with Butler Auth or this documentation site, but you’re not sure how to fix it yourself, please create an issue in the Butler Auth or Butler Auth docs repos. You can also create an issue about a specific doc page by clicking the Create project issue button in the top right hand corner of the page.