aboutsummaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
authorjacobherrington <jacobherringtondeveloper@gmail.com>2018-11-18 14:37:53 -0600
committerjacobherrington <jacobherringtondeveloper@gmail.com>2018-11-18 14:37:53 -0600
commitdc27efccdd4424c4af15b0d4338c3428bd77bb10 (patch)
treef22b8415b8c438385fb173893b46c7b3da6e636e /.github
parent218e50ce59c3abfa5ffdfac253cdeb2f74602da0 (diff)
downloadrails-dc27efccdd4424c4af15b0d4338c3428bd77bb10.tar.gz
rails-dc27efccdd4424c4af15b0d4338c3428bd77bb10.tar.bz2
rails-dc27efccdd4424c4af15b0d4338c3428bd77bb10.zip
Add comments to markdown templates
Diffstat (limited to '.github')
-rw-r--r--.github/issue_template.md9
-rw-r--r--.github/pull_request_template.md8
2 files changed, 8 insertions, 9 deletions
diff --git a/.github/issue_template.md b/.github/issue_template.md
index 2ff6a271db..87e666a7dd 100644
--- a/.github/issue_template.md
+++ b/.github/issue_template.md
@@ -1,13 +1,12 @@
### Steps to reproduce
-
-(Guidelines for creating a bug report are [available
-here](http://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#creating-a-bug-report))
+<!-- (Guidelines for creating a bug report are [available
+here](http://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#creating-a-bug-report)) -->
### Expected behavior
-Tell us what should happen
+<!-- Tell us what should happen -->
### Actual behavior
-Tell us what happens instead
+<!-- Tell us what happens instead -->
### System configuration
**Rails version**:
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index a36687ec99..85c0e29ff0 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,13 +1,13 @@
### Summary
-Provide a general description of the code changes in your pull
+<!-- Provide a general description of the code changes in your pull
request... were there any bugs you had fixed? If so, mention them. If
these bugs have open GitHub issues, be sure to tag them here as well,
-to keep the conversation linked together.
+to keep the conversation linked together. -->
### Other Information
-If there's anything else that's important and relevant to your pull
+<!-- If there's anything else that's important and relevant to your pull
request, mention that information here. This could include
benchmarks, or other information.
@@ -18,4 +18,4 @@ Finally, if your pull request affects documentation or any non-code
changes, guidelines for those changes are [available
here](http://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#contributing-to-the-rails-documentation)
-Thanks for contributing to Rails!
+Thanks for contributing to Rails! -->