norbertszivos/mail_plugger

View on GitHub
CONTRIBUTING.md

Summary

Maintainability
Test Coverage
# Contributing

If you discover issues, have ideas for improvements or new features,
please report them to the [issue tracker](https://github.com/MailToolbox/mail_plugger/issues) of the repository or
submit a pull request. Please, try to follow these guidelines when you
do so.

## Issue reporting

* Check that the issue has not already been reported.
* Check that the issue has not already been fixed in the latest code.
* Be clear, concise and precise in your description of the problem.
* Open an issue with a descriptive title and summary.
* Include any relevant code to the issue summary.

## Pull requests

* Fork the project.
* Use a feature branch to easily amend a pull request later, if necessary.
* Write good commit messages.
* Use the same coding conventions as the rest of the project.
* If your change has a corresponding open GitHub issue, prefix the commit message with `[#github-issue-number]`.
* Make sure to add tests for it.
* Make sure the test suite is passing (usually this is as simple as running `bundle exec rake`).
* Squash related commits together.
* Open a pull request that relates to *only* one subject with a clear title and description.