Commit 7a83df74 authored by Mark Fletcher's avatar Mark Fletcher

Link to the issue templates in Contributing guide

Change to use a better title style

Add backticks to code segments

Spelling and Grammar
parent b1add606
## Summary ### Summary
(Summarize the bug encountered concisely) (Summarize the bug encountered concisely)
## Steps to reproduce ### Steps to reproduce
(How one can reproduce the issue - this is very important) (How one can reproduce the issue - this is very important)
## Expected behavior ### Expected behavior
(What you should see instead) (What you should see instead)
## Actual behaviour ### Actual behaviour
(What actually happens) (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, (Paste any relevant logs - please use code blocks (```) to format console output,
logs, and code as it's very hard to read otherwise.) 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: (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: (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) (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: (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: (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) (If you can, link to the line of code that might be responsible for the problem)
## Description ### Description
Include problem, use cases, benefits, and/or goals
## Proposal (Include problem, use cases, benefits, and/or goals)
## Links / references ### Proposal
### Links / references
...@@ -144,7 +144,7 @@ code snippet right after your description in a new line: `~"feature proposal"`. ...@@ -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 Please keep feature proposals as small and simple as possible, complex ones
might be edited to make them small and simple. 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. 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 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 ...@@ -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 feature proposal. Show your support with an award emoji and/or join the
discussion. 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 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 when submitting the actual issue. You can copy-paste it and then edit as you
see fit. see fit.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment