Skip to content

Latest commit

 

History

History
23 lines (14 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

23 lines (14 loc) · 1.26 KB

Contributing

Bob follows the The Collective Code Construction Contract (C4).

Developing Bob

Checkout the dev guide!

Code style guide

The majority of Bob is written in Clojure and follows the community style guide. There are a few forms in the project which are not a part of the style guide but are to be styled as follows:

  1. failjure.core/try-all: Shall be styled as let.
  2. failjure.core/when-failed: Shall be styled as fn.

The recommended formatter is cljfmt and the code formatting rules can be found in .cljfmt.edn

Use of Git

  • Avoid plain git merge, and use rebasing instead, to avoid merge commits. This keeps the history much more readable for others to understand, review bisect and rollback.
  • When merging patches with multiple commits, try to make each patch meaningful.For example, fixes to patches should be squashed into the original patch. Security issues and other serious issues should be avoided in intermediate patches – even if they are fixed in later patches.

That's all folks! And Happy contributing!!