diff options
| -rw-r--r-- | .gitlab/issue_templates/Bug.md | 26 | ||||
| -rw-r--r-- | .gitlab/issue_templates/Feature Proposal.md | 9 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 4 |
3 files changed, 20 insertions, 19 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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f4b3d5d244..c457af2ae6f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -144,7 +144,7 @@ code snippet right after your description in a new line: `~"feature proposal"`. Please keep feature proposals as small and simple as possible, complex ones might be edited to make them small and simple. -Please submit Feature Proposals using the 'Feature Proposal' issue template provided on the issue tracker. +Please submit Feature Proposals using the ['Feature Proposal' issue template](.gitlab/issue_templates/Feature Proposal.md) provided on the issue tracker. For changes in the interface, it can be helpful to create a mockup first. If you want to create something yourself, consider opening an issue first to @@ -157,7 +157,7 @@ submitting your own, there's a good chance somebody else had the same issue or feature proposal. Show your support with an award emoji and/or join the discussion. -Please submit bugs using the 'Bug' issue template provided on the issue tracker. +Please submit bugs using the ['Bug' issue template](.gitlab/issue_templates/Bug.md) provided on the issue tracker. The text in the parenthesis is there to help you with what to include. Omit it when submitting the actual issue. You can copy-paste it and then edit as you see fit. |