File tree 1 file changed +32
-0
lines changed
1 file changed +32
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Contributing Guidelines
2
+
3
+ ** Do** follow [ the seven rules of a great Git commit message] [ 1 ] .
4
+
5
+ ** Do** follow [ the Clojure Style Guide] [ 2 ] .
6
+
7
+ ** Do** include tests for your change when appropriate.
8
+
9
+ ** Do** ensure that the CI checks pass.
10
+
11
+ ** Do** squash the commits in your PR to remove corrections
12
+ irrelevant to the code history, once the PR has been reviewed.
13
+
14
+ ** Do** feel free to pester the project maintainers about the PR if it
15
+ hasn't been responded to. Sometimes notifications can be missed.
16
+
17
+ ** Don't** include more than one feature or fix in a single PR.
18
+
19
+ ** Don't** include changes unrelated to the purpose of the PR. This
20
+ includes changing the project version number, adding lines to the
21
+ ` .gitignore ` file, or changing the indentation or formatting.
22
+
23
+ ** Don't** open a new PR if changes are requested. Just push to the
24
+ same branch and the PR will be updated.
25
+
26
+ ** Don't** overuse vertical whitespace; avoid multiple sequential blank
27
+ lines.
28
+
29
+ ** Don't** docstring private vars or functions.
30
+
31
+ [ 1 ] : https://chris.beams.io/posts/git-commit/#seven-rules
32
+ [ 2 ] : https://github.com/bbatsov/clojure-style-guide
You can’t perform that action at this time.
0 commit comments