I'm really glad you're reading this, because we need volunteer developers to help this project come to fruition.
We have a handful of Cucumber features, but most of our testbed consists of RSpec examples. Please write RSpec examples for new code you create.
Please send a GitHub Pull Request to pullsbury with a clear list of what you've done (read more about pull requests). When you send a pull request, we will love you forever if you include test examples. We can always use more test coverage. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
Start reading our code and you'll get the hang of it. We optimize for readability:
- We indent using four spaces (soft tabs)
- We follow the flake8 standards for our linting. We typically avoid the line length rules, as I feel that more then often, it makes the code harder to read.
- This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.
Thanks,
Anton Nguyen