[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/guru-mode fd80d94 14/42: added contribution guidelines
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/guru-mode fd80d94 14/42: added contribution guidelines |
Date: |
Wed, 11 Aug 2021 09:58:28 -0400 (EDT) |
branch: elpa/guru-mode
commit fd80d941cbfd4af806daebbbd091f0d71585f08f
Author: Bozhidar Batsov <bozhidar@tradeo.com>
Commit: Bozhidar Batsov <bozhidar@tradeo.com>
added contribution guidelines
---
CONTRIBUTING.md | 31 +++++++++++++++++++++++++++++++
1 file changed, 31 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..f03eda6
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,31 @@
+# Contributing
+
+If you discover issues, have ideas for improvements or new features, or
+want to contribute a new module, please report them to the
+[issue tracker][1] of the repository or submit a pull request. Please,
+try to follow these guidelines when you do so.
+
+## Issue reporting
+
+* Check that the issue has not already been reported.
+* Check that the issue has not already been fixed in the latest code
+ (a.k.a. `master`).
+* Be clear, concise and precise in your description of the problem.
+* Open an issue with a descriptive title and a summary in grammatically
correct,
+ complete sentences.
+* Include any relevant code to the issue summary.
+
+## Pull requests
+
+* Read [how to properly contribute to open source projects on Github][2].
+* Use a topic branch to easily amend a pull request later, if necessary.
+* Write [good commit messages][3].
+* Use the same coding conventions as the rest of the project.
+* Verify your Emacs Lisp code with `checkdoc` (<kbd>C-c ? d</kbd>).
+* Open a [pull request][4] that relates to *only* one subject with a clear
title
+ and description in grammatically correct, complete sentences.
+
+[1]: https://github.com/bbatsov/guru-mode/issues
+[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
+[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[4]: https://help.github.com/articles/using-pull-requests
- [nongnu] elpa/guru-mode a4f88ba 03/42: renamed to guru-mode, (continued)
- [nongnu] elpa/guru-mode a4f88ba 03/42: renamed to guru-mode, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 12d55ac 04/42: Update master, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 3221bcd 08/42: provided a non-global version of guru-mode, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 62a9a00 16/42: Bump version to 0.2, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode fc9dc59 17/42: Clean up a bit, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode b33e4d1 18/42: Update hook example, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 1086b77 20/42: only block keys with bindings in global-map, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode db23636 21/42: Merge pull request #5 from cowboyd/allow-minor-modes-to-reclaim-beginner-keys, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode eb38fb2 23/42: Fix delete key handling, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 062a417 27/42: Merge pull request #8 from ThibautVerron/keybindings-horizontal-scroll, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode fd80d94 14/42: added contribution guidelines,
ELPA Syncer <=
- [nongnu] elpa/guru-mode da632fa 26/42: Merge pull request #10 from syohex/update-url, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode ba88b73 09/42: minor documentation update, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode adf92d9 12/42: docs & code clean-up, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode a227ee5 15/42: Add the ability to only warn when arrow keys are being used, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 704a47d 25/42: Update MELPA URL, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode c180e05 30/42: Change "Home" and "End" replacements, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 3d53276 34/42: [Fix #7] Don't initialize the keymap at load time, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 71ccf45 37/42: Fix indentation, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode e91cdfb 40/42: Fix broken badge, ELPA Syncer, 2021/08/11
- [nongnu] elpa/guru-mode 0c0db11 10/42: Removed a duplicated keybinding in the keymap., ELPA Syncer, 2021/08/11