Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 1.13 KB

How to contribute

Contributions are welcome.

Please file bug reports and feature requests to https://github.com/hashobject/perun/issues.

For help and discussion

Clojurians slack (join) has a channel #perun for talk about Perun.

Making changes

  • Fork the repository on GitHub
  • Create a topic branch from where you want to base your work (usually the master branch)
  • Check the formatting rules from existing code (no trailing whitespace, mostly default indentation)
  • Test the changes
  • Push your code to your fork of the repository
  • Make a Pull Request

Commit messages

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
    • "Add x", "Fix y", "Support z", "Remove x"
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

For comprehensive explanation read this post by Chris Beams.