This repository has been archived by the owner on Apr 14, 2021. It is now read-only.

pitch-io / perun Public archive

forked from hashobject/perun

Notifications You must be signed in to change notification settings
Fork 0
Star 1

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

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

For comprehensive explanation read this post by Chris Beams.