File tree 1 file changed +31
-0
lines changed
1 file changed +31
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Contributing
2
+
3
+ If you discover issues, have ideas for improvements or new features, or
4
+ want to contribute a new module, please report them to the
5
+ [ issue tracker] [ 1 ] of the repository or submit a pull request. Please,
6
+ try to follow these guidelines when you do so.
7
+
8
+ ## Issue reporting
9
+
10
+ * Check that the issue has not already been reported.
11
+ * Check that the issue has not already been fixed in the latest code
12
+ (a.k.a. ` master ` ).
13
+ * Be clear, concise and precise in your description of the problem.
14
+ * Open an issue with a descriptive title and a summary in grammatically correct,
15
+ complete sentences.
16
+ * Include any relevant code to the issue summary.
17
+
18
+ ## Pull requests
19
+
20
+ * Read [ how to properly contribute to open source projects on Github] [ 2 ] .
21
+ * Use a topic branch to easily amend a pull request later, if necessary.
22
+ * Write [ good commit messages] [ 3 ] .
23
+ * Use the same coding conventions as the rest of the project.
24
+ * Verify your Emacs Lisp code with ` checkdoc ` (<kbd >C-c ? d</kbd >).
25
+ * Open a [ pull request] [ 4 ] that relates to * only* one subject with a clear title
26
+ and description in grammatically correct, complete sentences.
27
+
28
+ [ 1 ] : https://github.com/bbatsov/prelude/issues
29
+ [ 2 ] : http://gun.io/blog/how-to-github-fork-branch-and-pull-request
30
+ [ 3 ] : http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
31
+ [ 4 ] : https://help.github.com/articles/using-pull-requests
You can’t perform that action at this time.
0 commit comments