summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorBozhidar Batsov <bozhidar@batsov.com>2017-01-23 12:37:42 +0700
committerBozhidar Batsov <bozhidar@batsov.com>2017-01-23 12:37:42 +0700
commitfaa28cf6c3123596e722b5718aa5d706ddbfd97b (patch)
tree54a6a0830d8c045a2fd1a671668e0e1bfa3f7138 /.github
parentd9d7e94c06cd08f6b37b06ba31df60180b9d3626 (diff)
Link to the "Hacking on CIDER" manual section from some related documents
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md2
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md4
2 files changed, 6 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 71cac2dd..0d1a5423 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -32,6 +32,7 @@ reliably would also make a huge difference.
## Pull requests
+* Read the [Hacking on CIDER][8] manual section.
* 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.
* Use the same coding conventions as the rest of the project.
@@ -51,3 +52,4 @@ reliably would also make a huge difference.
[5]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
[6]: https://github.com/clojure-emacs/cider/blob/master/CHANGELOG.md
[7]: http://cider.readthedocs.org/en/latest/troubleshooting/
+[8]: https://cider.readthedocs.io/en/latest/hacking_on_cider/
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 9974639f..8c5fca30 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -16,4 +16,8 @@ by checking the relevant checkboxes):
Thanks!
+*If you're just starting out to hack on CIDER you might find this [section of its
+manual][2] extremely useful.*
+
[1]: https://github.com/clojure-emacs/cider/blob/master/.github/CONTRIBUTING.md
+[2]: https://cider.readthedocs.io/en/latest/hacking_on_cider/