Commit 2e297c1ec275c20602d5e48322613e88d8dbab13
Exists in
master
and in
4 other branches
Merge pull request #4092 from bbodenmiller/update-issue-guidelines
improved issue reporting guidelines
Showing
1 changed file
with
16 additions
and
13 deletions
Show diff stats
CONTRIBUTING.md
| ... | ... | @@ -4,29 +4,32 @@ This guide details how to use issues and pull requests to improve GitLab. |
| 4 | 4 | |
| 5 | 5 | ## Closing policy for issues and pull requests |
| 6 | 6 | |
| 7 | -Issues and pull requests not in line with the guidelines listed in this document will be closed with just a link to this paragraph. GitLab is a popular open source project and the capacity to deal with issues and pull requests is limited. To get support for your problems please use other channels as detailed in [the getting help section of the readme](https://github.com/gitlabhq/gitlabhq#getting-help). Professional [support subscriptions](http://www.gitlab.com/subscription/) and [consulting services](http://www.gitlab.com/consultancy/) are available from [GitLab.com](http://www.gitlab.com/). | |
| 7 | +Issues and pull requests not in line with the guidelines listed in this document will be closed. GitLab is a popular open source project and the capacity to deal with issues and pull requests is limited. To get support for your problems please use other channels as detailed in [the getting help section of the readme](https://github.com/gitlabhq/gitlabhq#getting-help). Professional [support subscriptions](http://www.gitlab.com/subscription/) and [consulting services](http://www.gitlab.com/consultancy/) are available from [GitLab.com](http://www.gitlab.com/). | |
| 8 | 8 | |
| 9 | 9 | ## Issue tracker |
| 10 | 10 | |
| 11 | 11 | The [issue tracker](https://github.com/gitlabhq/gitlabhq/issues) is only for obvious bugs or misbehavior in the latest [stable or development release of GitLab](MAINTENANCE.md). When submitting an issue please conform to the issue submission guidelines listed below. |
| 12 | 12 | |
| 13 | 13 | Do not use the issue tracker for feature requests. We have a specific |
| 14 | -[Feedback and suggestions forum](http://feedback.gitlab.com) for this purpose. | |
| 14 | +[feedback and suggestions forum](http://feedback.gitlab.com) for this purpose. | |
| 15 | 15 | |
| 16 | -Please send a pull request with a tested solution or a pull request with a failing test instead of opening an issue if you can. If you're unsure where to post, post to the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) first. There are a lot of helpful GitLab users there who may be able to help you quickly. If your particular issue turns out to be a bug, it will find its way from there. | |
| 16 | +Please send a pull request with a tested solution or a pull request with a failing test instead of opening an issue if you can. If you're unsure where to post, post to the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) or [Stack Overflow](http://stackoverflow.com/questions/tagged/gitlab) first. There are a lot of helpful GitLab users there who may be able to help you quickly. If your particular issue turns out to be a bug, it will find its way from there. | |
| 17 | 17 | |
| 18 | 18 | ### Issue tracker guidelines |
| 19 | 19 | |
| 20 | -**[Search](https://github.com/gitlabhq/gitlabhq/search?q=&ref=cmdform&type=Issues)** for similar entries before submitting your own, there's a good chance somebody else had the same issue or idea. Show your support with `:+1:` and/or join the discussion. | |
| 21 | - | |
| 22 | -* Only report issues for supported versions according to the [maintenance policy](MAINTENANCE.md) | |
| 23 | -* Summarize your issue in one sentence (what goes wrong, what did you expect to happen) | |
| 24 | -* Describe your issue in detail | |
| 25 | -* How can we reproduce the issue on the [GitLab Vagrant virtual machine](https://github.com/gitlabhq/gitlab-vagrant-vm) (start with: `vagrant destroy && vagrant up && vagrant ssh`) | |
| 26 | -* Add the last commit sha1 of the GitLab version you used to replicate the issue | |
| 27 | -* Add logs or screen shots when possible | |
| 28 | -* Link to the line of code that might be responsible for the problem | |
| 29 | -* Describe your setup (use relevant parts from `sudo -u gitlab -H bundle exec rake gitlab:env:info`) | |
| 20 | +**[Search](https://github.com/gitlabhq/gitlabhq/search?q=&ref=cmdform&type=Issues)** for similar entries before submitting your own, there's a good chance somebody else had the same issue. Show your support with `:+1:` and/or join the discussion. Please submit issues in the following format: | |
| 21 | + | |
| 22 | +1. **Summary:** Summarize your issue in one sentence (what goes wrong, what did you expect to happen) | |
| 23 | +2. **Steps to reproduce:** How can we reproduce the issue, preferably on the [GitLab Vagrant virtual machine](https://github.com/gitlabhq/gitlab-vagrant-vm) (start with: `vagrant destroy && vagrant up && vagrant ssh`) | |
| 24 | +3. **Expected behavior:** Describe your issue in detail | |
| 25 | +4. **Observed behavior** | |
| 26 | +5. **Relevant logs and/or screen shots:** Please use code blocks (\`\`\`) to format console output, logs, and code as it's very hard to read otherwise. | |
| 27 | +6. **Output of checks** | |
| 28 | + * Results of GitLab [Application Check](doc/install/installation.md#check-application-status) (`sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production`); we will only investigate if the tests are passing | |
| 29 | + * Version of GitLab you are running; we will only investigate issues in the latest stable and development releases as per the [maintenance policy](MAINTENANCE.md) | |
| 30 | + * Add the last commit sha1 of the GitLab version you used to replicate the issue (obtainable from the help page) | |
| 31 | + * Describe your setup (use relevant parts from `sudo -u gitlab -H bundle exec rake gitlab:env:info`) | |
| 32 | +7. **Possible fixes**: If you can, link to the line of code that might be responsible for the problem | |
| 30 | 33 | |
| 31 | 34 | ## Pull requests |
| 32 | 35 | ... | ... |