[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/swift-mode 787658f 305/496: Update CONTRIBUTING.md
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/swift-mode 787658f 305/496: Update CONTRIBUTING.md |
Date: |
Sun, 29 Aug 2021 11:33:56 -0400 (EDT) |
branch: elpa/swift-mode
commit 787658fbcbf73640befbf150a0439ed709ae7509
Author: taku0 <mxxouy6x3m_github@tatapa.org>
Commit: taku0 <mxxouy6x3m_github@tatapa.org>
Update CONTRIBUTING.md
---
CONTRIBUTING.md | 28 +++++++++++++++++++++++++---
1 file changed, 25 insertions(+), 3 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0759319..47a4cc0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -9,7 +9,29 @@ repository. Follow the guidelines below to make sure
everything goes smoothly.
- Check that the issue has not already been reported
- Check that the issue has not already been fixed in the latest code
- Open an issue with a clear title
-- Write as grammatically correct as you can in the description.
+- Use concise English.
+- Use code as our common language.
+ - An example is worth a thousand words. For example:
+
+ > It should be indented like this:
+ ```swift
+ guard
+ var x = xx else {
+ foo()
+ foo()
+ }
+ ```
+ > But actually it is indented like this:
+ ```swift
+ guard
+ var x = xx else {
+ foo()
+ foo()
+ }
+ ```
+ - A link to the language specification or other project is also worth a
+ thousand words. For example, “I want this feature (links to a elisp
+ function of other project)”.
## Pull requests
@@ -17,6 +39,7 @@ repository. Follow the guidelines below to make sure
everything goes smoothly.
- Follow the coding conventions already in use
- Verify Emacs Lisp code with `checkdoc`
- Add unit tests whenever possible
+- Run `make check` and ensure no errors other than known-bugs.
- Open a [pull request](https://help.github.com/articles/using-pull-requests)
relating to a single issue.
@@ -24,8 +47,7 @@ repository. Follow the guidelines below to make sure
everything goes smoothly.
### Naming
-- Use a `swift-mode-` prefix for all public names.
-- Use a `swift-mode--` prefix for all internal names.
+Use a `swift-mode:` prefix.
### Docstrings
- [nongnu] elpa/swift-mode 7f25806 241/496: Add as! operator, (continued)
- [nongnu] elpa/swift-mode 7f25806 241/496: Add as! operator, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode 86339ed 247/496: Fix curly bracket's syntax table to enable electric-pair, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode 37cab39 263/496: Improve indentation for switch and class statements, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode cb7ba6f 245/496: Add an option for indent after hanging comma, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode 0185315 274/496: Merge pull request #107 from uk-ar/fix-forward-list, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode 27ec163 286/496: Merge pull request #113 from uk-ar/add-keyword-for-attribute, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode f43317e 290/496: Add MELPA badge in README, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode c73ce40 301/496: Update README.md about swift3-mode, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode 7fc03bf 295/496: Merge pull request #119 from syohex/update-url, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode 73abb98 292/496: Use cl-lib function instead of cl.el one, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode 787658f 305/496: Update CONTRIBUTING.md,
ELPA Syncer <=
- [nongnu] elpa/swift-mode 0e24233 307/496: Fix forward/backward-sexp inside comments, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode 60dab9b 308/496: Update test to return informative exit status, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode 01a1127 318/496: Fix indentation before "where", ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode b135df3 316/496: Fix output messages of the test, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode 7837c90 319/496: Fix indentation around "where" and "catch", ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode 42a209c 322/496: Fix indentation of guard, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode ab9f414 320/496: Fix indentation of close curly brace of switch, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode 97d86cd 326/496: Tweak test runner, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode ea77cf9 328/496: Add comments, ELPA Syncer, 2021/08/29
- [nongnu] elpa/swift-mode 6cd2948 342/496: Bump version to 2.2.1, ELPA Syncer, 2021/08/29