We would love you to contribute to localstripe and help make it even better than it is today!
We maintain localstripe voluntarily, these guidelines goal is to make our reviews as easy as possible and keep a helpful Git history.
We receive email notifications during conversations but also when you push on branches of open pull requests. To avoid spamming us please open pull requests only when you are 90% sure commits, linting and tests are ready. We will help you with the last 10%.
Please describe your changes (fix or feature) inside the commits messages. The commit is the key piece in a Git repository to track change over long term. So each commit should be as complete and as simple as possible.
A pull request can contain multiple commits if you think it's relevant, but each commit should solve one problem and only one. If one of your commits adds an issue, that you fix in the next commit of the same pull request, please squash them.
The Linux kernel is the biggest open-source project of all time, so you can basically refer to it on how to commit.
We are less than likely to accept them. The main reason is that it makes the Git history harder to explore.
Before opening a pull request, please run flake8 as our automated tests
do.
Before opening a pull request, please run the test suite. You can use:
find -name '*.py' | entr -r python -m localstripe --from-scratch
curl -X DELETE localhost:8420/_config/data && ./test.sh