From 7a83df749e3ff3c88cff9f348ed5ed222a15508a Mon Sep 17 00:00:00 2001 From: Mark Fletcher Date: Thu, 25 Aug 2016 15:41:51 +0100 Subject: Link to the issue templates in Contributing guide Change to use a better title style Add backticks to code segments Spelling and Grammar --- .gitlab/issue_templates/Bug.md | 26 +++++++++++++------------- .gitlab/issue_templates/Feature Proposal.md | 9 +++++---- 2 files changed, 18 insertions(+), 17 deletions(-) (limited to '.gitlab/issue_templates') diff --git a/.gitlab/issue_templates/Bug.md b/.gitlab/issue_templates/Bug.md index f6f5879c21a..b676916fdf4 100644 --- a/.gitlab/issue_templates/Bug.md +++ b/.gitlab/issue_templates/Bug.md @@ -1,44 +1,44 @@ -## Summary +### Summary (Summarize the bug encountered concisely) -## Steps to reproduce +### Steps to reproduce (How one can reproduce the issue - this is very important) -## Expected behavior +### Expected behavior (What you should see instead) -## Actual behaviour +### Actual behaviour (What actually happens) -## Relevant logs and/or screenshots +### Relevant logs and/or screenshots (Paste any relevant logs - please use code blocks (```) to format console output, logs, and code as it's very hard to read otherwise.) -## Output of checks +### Output of checks -### Results of GitLab Application Check +#### Results of GitLab application Check (For installations with omnibus-gitlab package run and paste the output of: -sudo gitlab-rake gitlab:check SANITIZE=true) +`sudo gitlab-rake gitlab:check SANITIZE=true`) (For installations from source run and paste the output of: -sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production SANITIZE=true) +`sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production SANITIZE=true`) (we will only investigate if the tests are passing) -### Results of GitLab Environment Info +#### Results of GitLab environment info (For installations with omnibus-gitlab package run and paste the output of: -sudo gitlab-rake gitlab:env:info) +`sudo gitlab-rake gitlab:env:info`) (For installations from source run and paste the output of: -sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production) +`sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production`) -## Possible fixes +### Possible fixes (If you can, link to the line of code that might be responsible for the problem) diff --git a/.gitlab/issue_templates/Feature Proposal.md b/.gitlab/issue_templates/Feature Proposal.md index ea009c32296..ea895ee6275 100644 --- a/.gitlab/issue_templates/Feature Proposal.md +++ b/.gitlab/issue_templates/Feature Proposal.md @@ -1,6 +1,7 @@ -## Description -Include problem, use cases, benefits, and/or goals +### Description -## Proposal +(Include problem, use cases, benefits, and/or goals) -## Links / references +### Proposal + +### Links / references -- cgit v1.2.3