branch: elpa/clojure-ts-mode
commit 06ab14a443501c7318fafc36f197afac78a61876
Author: Bozhidar Batsov <bozhi...@batsov.dev>
Commit: Bozhidar Batsov <bozhi...@batsov.dev>
Add the standard GitHub templates
Those are adapted from clojure-mode's templates.
---
.github/ISSUE_TEMPLATE.md | 33 ++++++++++++++++++++++++++++++
.github/PULL_REQUEST_TEMPLATE.md | 16 +++++++++++++++
CHANGELOG.md | 3 +++
CONTRIBUTING.md | 43 ++++++++++++++++++++++++++++++++++++++++
4 files changed, 95 insertions(+)
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000000..e3e5cda2b4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,33 @@
+*Use the template below when reporting bugs. Please, make sure that
+you're running the latest stable clojure-mode and that the problem you're
reporting
+hasn't been reported (and potentially fixed) already.*
+
+**Please, remove all of the placeholder text (the one in italics) in your
final report!**
+
+## Expected behavior
+
+## Actual behavior
+
+## Steps to reproduce the problem
+
+*This is extremely important! Providing us with a reliable way to reproduce
+a problem will expedite its solution.*
+
+## Environment & Version information
+
+### clojure-ts-mode version
+
+*Include here the version string displayed by `M-x
+clojure-ts-mode-display-version`. Here's an example:*
+
+```
+clojure-ts-mode (version 5.2.0)
+```
+
+### Emacs version
+
+*E.g. 29.1* (use <kbd>C-h C-a</kbd> to see it)
+
+### Operating system
+
+*E.g. Windows 10*
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000000..662052f778
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,16 @@
+**Replace this placeholder text with a summary of the changes in your PR.**
+
+-----------------
+
+Before submitting a PR mark the checkboxes for the items you've done (if you
+think a checkbox does not apply, then leave it unchecked):
+
+- [ ] The commits are consistent with our [contribution guidelines][1].
+<!-- - [ ] You've added tests (if possible) to cover your change(s). Bugfix,
indentation, and font-lock tests are extremely important! -->
+- [ ] You've run `M-x checkdoc` and fixed any warnings in the code you've
written.
+- [ ] You've updated the changelog (if adding/changing user-visible
functionality).
+- [ ] You've updated the readme (if adding/changing user-visible
functionality).
+
+Thanks!
+
+[1]:
https://github.com/clojure-emacs/clojure-ts-mode/blob/master/CONTRIBUTING.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000000..fb63812604
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,3 @@
+# Changelog
+
+## master (unreleased)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000000..9a6a3fe6ff
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,43 @@
+# Contributing
+
+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.
+
+## 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.
+* Mention your Emacs version and operating system.
+* Mention `clojure-ts-mode`'s version info (`M-x
clojure-ts-mode-version-info`), e.g.:
+
+```el
+clojure-ts-mode (version 2.1.1)
+```
+
+* 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] Font-lock
properly ...`)
+* Update the [changelog][6].
+* Use the same coding conventions as the rest of the project.
+* Verify your Emacs Lisp code with `checkdoc` (<kbd>C-c ? d</kbd>).
+* [Squash related commits together][5].
+* 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/clojure-emacs/clojure-ts-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
+[5]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
+[6]: https://github.com/clojure-emacs/clojure-ts-mode/blob/master/CHANGELOG.md
