diff options
| author | Mark Fletcher <mark@gitlab.com> | 2016-08-25 15:41:51 +0100 |
|---|---|---|
| committer | Mark Fletcher <mark@gitlab.com> | 2016-08-25 15:48:08 +0100 |
| commit | 7a83df749e3ff3c88cff9f348ed5ed222a15508a (patch) | |
| tree | c8f75dbb8f19e4c2120905e4cf77a8bcd2d1d31a /.gitlab/issue_templates | |
| parent | b1add60648554d5f5ae6990b95405d2b97aac627 (diff) | |
| download | gitlab-ce-7a83df749e3ff3c88cff9f348ed5ed222a15508a.tar.gz | |
Link to the issue templates in Contributing guide
Change to use a better title style
Add backticks to code segments
Spelling and Grammar
Diffstat (limited to '.gitlab/issue_templates')
| -rw-r--r-- | .gitlab/issue_templates/Bug.md | 26 | ||||
| -rw-r--r-- | .gitlab/issue_templates/Feature Proposal.md | 9 |
2 files changed, 18 insertions, 17 deletions
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 |