Skip to content

Latest commit

 

History

History
22 lines (18 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

22 lines (18 loc) · 1.5 KB
Raw

Contributing

Contributions are welcomed and will be fully credited.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Pull Request Process

  1. Follow PSR-2 Coding Standard. The easiest way to apply the conventions is to install PHP Code Sniffer.
  2. Ensure any install or build dependencies are removed by the end of the development.
  3. Update the README.md with details of changes to the interface, this includes new environment variables and useful file locations.
  4. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  5. Create feature branches. Don't ask us to pull from your master branch.
  6. One pull request per feature. If you want to do more than one thing, send multiple pull requests.
  7. Send coherent history. Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
  8. Use git via docker to allow overcommit to run pre-commit and pre-push hooks
docker exec -it jiralogger-cli git commit
docker exec -it jiralogger-cli git push origin <branch>
  1. Be patient, issues and pull-requests are reviewed in free time.

Happy Coding!