[elpa] externals/topspace 3669113748 151/181: Update contributing files

[ELPA Syncer]

branch: externals/topspace
commit 3669113748e0ada11e2c4771151da66dd87a0fbf
Author: Trevor Pogue <poguete@mcmaster.ca>
Commit: Trevor Pogue <poguete@mcmaster.ca>

    Update contributing files
---
 .github/ISSUE_TEMPLATE/bug_report.md      |  2 ++
 .github/ISSUE_TEMPLATE/custom.md          |  2 +-
 .github/ISSUE_TEMPLATE/feature_request.md |  2 ++
 .github/PULL_REQUEST_TEMPLATE.md          | 13 +++++++------
 CONTRIBUTING.md                           | 22 +++++++++++++++++-----
 README.md                                 |  4 ++--
 6 files changed, 31 insertions(+), 14 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md 
b/.github/ISSUE_TEMPLATE/bug_report.md
index 9c1250b085..0a4e561bf8 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,6 +7,8 @@ assignees: ''
 
 ---
 
+<!-- Thank you for helping improve topspace! -->
+
 **Describe the bug**
 A clear and concise description of what the bug is.
 
diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md
index 48d5f81fa4..0e3e33df50 100644
--- a/.github/ISSUE_TEMPLATE/custom.md
+++ b/.github/ISSUE_TEMPLATE/custom.md
@@ -7,4 +7,4 @@ assignees: ''
 
 ---
 
-
+<!-- Thank you for helping improve topspace! Enter you request below. -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md 
b/.github/ISSUE_TEMPLATE/feature_request.md
index bbcbbe7d61..0ea5b78998 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -7,6 +7,8 @@ assignees: ''
 
 ---
 
+<!-- Thank you for helping improve topspace! -->
+
 **Is your feature request related to a problem? Please describe.**
 A clear and concise description of what the problem is. Ex. I'm always 
frustrated when [...]
 
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 1c1a029100..e15a3cdf80 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,17 +1,18 @@
-**Replace this placeholder text with a summary of the changes in your PR.
-The more detailed you are, the better.**
+<!-- Thank you for improving topspace! -->
+
+<!-- Add here a summary of the changes in your PR with bullet points.
+The more detailed, the better. -->
 
 -----------------
 
 ### Checklist
 
-<!-- Please confirm with `x`: -->
+<!-- Please confirm by replacing each `[ ]` with `[x]`: -->
 
 - [ ] I have read the topspace [contributing 
guidelines](https://github.com/trevorpogue/topspace/blob/main/CONTRIBUTING.md)
+- [ ] I have added tests (if possible) to cover my change(s)
 - [ ] My changes follow the [Emacs Lisp 
conventions](https://www.gnu.org/software/emacs/manual/html_node/elisp/Tips.html)
 and the [Emacs Lisp Style 
Guide](https://github.com/bbatsov/emacs-lisp-style-guide)
 - [ ] I've used the latest version of 
[package-lint](https://github.com/purcell/package-lint) to check for packaging 
issues, and addressed its feedback
 - [ ] The new code is not generating bytecode warnings
 - [ ] I've updated the readme (if adding/changing user-visible functionality)
-- [ ] I have confirmed some of these without doing them
-
-<!-- Thank you! -->
+- [ ] I have confirmed some of these without doing them (this box shouldn't be 
marked)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 610b66dd8d..14b9f7da29 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,15 +1,17 @@
 # Contributing
 
-Feel free to work on reported and unresolved issues. 
-If you discover issues, have ideas for improvements or new features, 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.
+Contributions are welcome! Please [open an issue][1]
+if you find a bug, have a feature request, or have any suggestions for
+the project at all.
+Also feel free to make pull requests yourself instead of issues,
+or make pull requests for any existing unresolved issues.
+Try to follow the following guidelines if you open an issue or pull request:
 
 ## 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`).
+  (a.k.a. `main`).
 * 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.
@@ -18,6 +20,7 @@ request. Please, try to follow these guidelines when you do 
so.
 
 ## Pull requests
 
+* Add tests (if possible) to cover your change(s)
 * Follow the [Emacs Lisp 
conventions](https://www.gnu.org/software/emacs/manual/html_node/elisp/Tips.html)
 and the [Emacs Lisp Style 
Guide](https://github.com/bbatsov/emacs-lisp-style-guide)
 * 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.
@@ -28,7 +31,16 @@ request. Please, try to follow these guidelines when you do 
so.
 * Open a [pull request][4] that relates to *only* one subject with a clear 
title
   and description in grammatically correct, complete sentences.
 
+## Running Tests
+Check [test.yml][5] to see the latest testing frameworks being used, and the 
command(s) required to run the tests. When last updating this file, cask and 
buttercup were being used to run the tests like so:
+
+```
+cask install
+cask exec buttercup -L .
+```
+
 [1]: https://github.com/trevorpogue/topspace/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/trevorpogue/topspace/blob/main/.github/workflows/test.yml
diff --git a/README.md b/README.md
index 11fdbbf430..6072ba9b01 100644
--- a/README.md
+++ b/README.md
@@ -5,8 +5,8 @@
 
 <p align="center">
    <a 
href="https://github.com/trevorpogue/topspace/actions/workflows/test.yml/";><img 
src="https://github.com/trevorpogue/topspace/actions/workflows/test.yml/badge.svg";
 height="20"/></a>
-  <a href='https://coveralls.io/github/trevorpogue/topspace?branch=main'><img 
src='https://coveralls.io/repos/github/trevorpogue/topspace/badge.svg?branch=main&1'
 alt='Coverage Status' /></a>
-     <a 
href="https://github.com/trevorpogue/topspace/blob/main/.github/workflows/test.yml";><img
 
src="https://img.shields.io/badge/Supports-Emacs_25.1--28.1-blueviolet.svg?style=flat-square&logo=GNU%20Emacs&logoColor=whit";
 height="20"/></a>
+  <a href='https://coveralls.io/github/trevorpogue/topspace?branch=main'><img 
src='https://coveralls.io/repos/github/trevorpogue/topspace/badge.svg?branch=main&0'
 alt='Coverage Status' /></a>
+  <a 
href="https://github.com/trevorpogue/topspace/blob/main/.github/workflows/test.yml";><img
 
src="https://img.shields.io/badge/Emacs-25.1+-blueviolet.svg?style=flat-square&logo=GNU%20Emacs&logoColor=whit";
 height="20"/></a>
   <a href="http://melpa.org/#/topspace";><img 
src="http://melpa.org/packages/topspace-badge.svg"; height="20"/></a>
   <a href="http://stable.melpa.org/#/topspace";><img 
src="http://stable.melpa.org/packages/topspace-badge.svg"; height="20"/></a>