Contributing

This project would not exist without all of its users and contributors.

If you have ideas on how to make the configuration easier to maintain or improve its performance, do not hesitate to fork and send pull requests.

Issue Reporting

• Check that the issue has not already been reported.
• Check that the issue has not already been fixed in the latest code.
• Open an issue with a clear title and description in grammatically correct, complete sentences.

Pull Request

• Read how to properly contribute to open source projects on GitHub.
• Use a topic branch to easily amend a pull request later, if necessary.
• Write good commit messages.
• Squash commits on the topic branch before opening a pull request.
• Use the same coding style and spacing. Limit your lines to 80 columns, unless you are entering a long url.
• Open a pull request that relates to but one subject with a clear title and description in grammatically correct, complete sentences.

Readme

• Document your changes in the README.mkd file, if necessary.
• Pull requests fixing inconsistencies in the Readme file and the actual behaviour, or otherwise improving the Readme are also welcome.

Tests

• If you are adding a new feature, please consider adding a test or two for it.
• Pull requests that add no new features, but only new tests testing functionality not already tested, are also welcome.

Backwards Compatibility

• If you are considering sending a pull request that breaks backwards compatibility, please don't. It is very likely that it will be rejected.
• However, we do recognize a certain class of improvements break backwards compatibility. Such exceptions do occur, but I encourage you to first open an issue and discuss your idea before spending time on a pull request that breaks backwards compatibility.

Credit

Document originally taken from CONTRIBUTING.md from the prezto project.