File tree Expand file tree Collapse file tree 1 file changed +32
-0
lines changed Expand file tree Collapse file tree 1 file changed +32
-0
lines changed Original file line number Diff line number Diff line change
1
+ # How to contribute
2
+
3
+ Contributions are welcome.
4
+
5
+ Please file bug reports and feature requests to https://github.com/adzerk-oss/boot-cljs/issues .
6
+
7
+ ## Hacking
8
+
9
+ Check [ development guide] ( https://github.com/adzerk-oss/boot-cljs/wiki/Development ) on wiki for how
10
+ to build and test boot-cljs locally.
11
+
12
+ ## Making changes
13
+
14
+ * Fork the repository on Github
15
+ * Create a topic branch from where you want to base your work (usually the master branch)
16
+ * Check the formatting rules from existing code (no trailing whitepace, mostly default indentation)
17
+ * Ensure any new code is well-tested, and if possible, any issue fixed is covered by one or more new tests
18
+ * Verify that all tests pass using ``` boot run-tests ``` and test the changes manually as our test suite is not very comprehesive
19
+ * Push your code to your fork of the repository
20
+ * Make a Pull Request
21
+
22
+ ## Commit messages
23
+
24
+ 1 . Separate subject from body with a blank line
25
+ 2 . Limit the subject line to 50 characters
26
+ 3 . Capitalize the subject line
27
+ 4 . Do not end the subject line with a period
28
+ 5 . Use the imperative mood in the subject line
29
+ - "Add x", "Fix y", "Support z", "Remove x"
30
+ 6 . Wrap the body at 72 characters
31
+ 7 . Use the body to explain what and why vs. how
32
+
You can’t perform that action at this time.
0 commit comments