aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRafael França <rafaelmfranca@gmail.com>2018-11-19 17:18:07 -0500
committerGitHub <noreply@github.com>2018-11-19 17:18:07 -0500
commitdf9dd4801b3c8a781d53680a3f5ec7dd0f7515e3 (patch)
treed0b2008788fe81467f2817c291fafed250096081
parenta95c2eca482de31c0f22288e110bbcbf4daf67dc (diff)
parentdc27efccdd4424c4af15b0d4338c3428bd77bb10 (diff)
downloadrails-df9dd4801b3c8a781d53680a3f5ec7dd0f7515e3.tar.gz
rails-df9dd4801b3c8a781d53680a3f5ec7dd0f7515e3.tar.bz2
rails-df9dd4801b3c8a781d53680a3f5ec7dd0f7515e3.zip
Merge pull request #34482 from jacobherrington/chore/add-comments-to-templates
Add comments to markdown templates
-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! -->