Contributing

Spree Analysis is an open source project and we encourage contributions.

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

by using prerelease versions
by reporting bugs
by suggesting new features
by writing translations
by writing or editing documentation
by writing specifications
by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
by refactoring code
by resolving issues
by reviewing patches

Filing an issue

When filing an issue on this extension, please first do these things:

In the issue itself please provide:

In 99% of cases, this information is enough to determine the cause and solution to the problem that is being described.

We gladly accept pull requests to fix bugs and, in some circumstances, add new features to this extension.

Here's a quick guide:

Fork the repo.
Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate.
Create new branch then make changes and add tests for your changes. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need tests!
Push to your fork and submit a pull request. If the changes will apply cleanly to the latest stable branches and master branch, you will only need to submit one pull request.

At this point you're waiting on us. We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted, taken straight from the Ruby on Rails guide:

Use Rails idioms and helpers.
Include tests that fail without your code, and pass with it.
Update the documentation, the surrounding one, examples elsewhere, guides, whatever is affected by your contribution.