[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/crux 3042f6f 029/112: Add some contribution guidelines
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/crux 3042f6f 029/112: Add some contribution guidelines |
Date: |
Wed, 11 Aug 2021 09:57:47 -0400 (EDT) |
branch: elpa/crux
commit 3042f6f5be197ea5159dd7c1ecefd1c58bca5c86
Author: Bozhidar Batsov <bozhidar@batsov.com>
Commit: Bozhidar Batsov <bozhidar@batsov.com>
Add some contribution guidelines
---
CONTRIBUTING.md | 34 ++++++++++++++++++++++++++++++++++
1 file changed, 34 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..c2cf1a0
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,34 @@
+# 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].
+* Mention related tickets in the commit messages (e.g. `[Fix #N] Add missing
autoload cookies`)
+* Update the [changelog][5].
+* 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/crux/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
+[5]: https://github.com/bbatsov/crux/blob/master/CHANGELOG.md
- [nongnu] elpa/crux 1e591c5 031/112: Merge pull request #16 from jiegec/master, (continued)
- [nongnu] elpa/crux 1e591c5 031/112: Merge pull request #16 from jiegec/master, ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux ca62859 038/112: Merge pull request #22 from dgtized/fix-tranpose-typo, ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux fde9d4b 044/112: Fix malformed header line, ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux 5b3c815 047/112: Release 0.3, ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux 3e03d72 049/112: Don't use dash.el function (#34), ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux b60d9f4 051/112: Fix a compilation warning, ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux 54cc9b8 056/112: Fix typo in crux-top-join-line, ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux 11096b9 058/112: Fix typo in keybindings (#47), ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux cedec52 063/112: Mark crux-recentf-ido-find-file as obsolete, ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux 66954bf 022/112: Mention crux-indent-defun, ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux 3042f6f 029/112: Add some contribution guidelines,
ELPA Syncer <=
- [nongnu] elpa/crux 225b5e3 042/112: Merge pull request #29 from Wilfred/rename_file_and_buffer_tweaks, ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux 6ae09d0 045/112: Add functions on duplicate current line or region (#31), ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux 4302357 052/112: Make crux-visit-term-buffer ask to restart dead process (#36), ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux 2e16b82 087/112: Rework `move-to-mode-line-start` to add extensibility (#71), ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux bb5a133 090/112: Simplify a bit of code, ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux 1fa7162 091/112: Optionally move visually in `move-to-mode-line-start', ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux dcd693c 093/112: Rename move-to-mode-line-start to crux-move-to-mode-line-start, ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux e805ab7 057/112: Use synchronous process for crux-open-with, ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux 4f5c8fe 059/112: [Fix #46] Address two issues with crux-move-beginning-line (#48), ELPA Syncer, 2021/08/11
- [nongnu] elpa/crux 49dc7d7 067/112: Remove unused prefix argument from crux-smart-kill-line, ELPA Syncer, 2021/08/11