First off, thank you for considering contributing to Stein.
Stein is an open source project and we would love to receive contributions from our community — you!
There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, creating tests, submitting bug reports and feature requests, or writing code which can be incorporated into Stein itself. We greatly value all contributions.
The process of setting up Stein for development isn't different. To run the server in development mode, just run
$ npm run dev
This starts the server with Nodemon, to restart the server automatically on changes. It also indicates to server to switch to the development environment.
As a result, certain security measures, such as allowing cookies only over HTTPS, are disabled for convenience.
The master branch contains the latest changes, and is not guaranteed to be stable. It represents WIP for the next release. Stable versions are tagged using SemVer.
First you'll need to fork the repository.
On your fork, create a branch and work on it. Submit your pull requests to the master, if any instruction is not explicitly specified for your changes by the maintainers.
We have a handful of simple standards for commit messages to keep complete track of changes.
- 1st line: Max 90 character summary written in past tense
- 2nd line: [Always blank]
- 3rd line: refs/closes #000 or no issue
- 4th line: A list of extra details or anything else worth mentioning
Please provide plenty of context and reasoning around your changes, to help us merge quickly. Closing an already open issue is our preferred workflow. If your PR gets out of date, we may ask you to rebase as you are more familiar with your changes than we will be.
The automated tests are currently in development. Changes have to be manually verified at the moment ⚒