Download as
Browse Code »

Commit b686b4b9623f277c35d0972ada4d8f8803cb7c97

Authored by Ben Bodenmiller
1 parent 5315fd5a
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

minor contributing guide updates 

* issues & pr in English
* appropriate language
* typo & format fix
* not catch all pull request
* update changelog
Showing 1 changed file with 7 additions and 3 deletions   Show diff stats
CONTRIBUTING.md
  Diff comments   View file @b686b4b
@@ -8,6 +8,8 @@ GitLab is a popular open source project and the capacity to deal with issues and @@ -8,6 +8,8 @@ GitLab is a popular open source project and the capacity to deal with issues and
8 8
9 Please treat our volunteers with courtesy and respect, it will go a long way towards getting your issue resolved. 9 Please treat our volunteers with courtesy and respect, it will go a long way towards getting your issue resolved.
10 10
  11 +Issues and pull requests should be in English and contain appropriate language for audiences of all ages.
  12 +
11 ## Issue tracker 13 ## Issue tracker
12 14
13 To get support for your particular problem please use the 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/). 15 To get support for your particular problem please use the 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/).
@@ -26,7 +28,7 @@ Please send a pull request with a tested solution or a pull request with a faili @@ -26,7 +28,7 @@ Please send a pull request with a tested solution or a pull request with a faili
26 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`) 28 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`)
27 3. **Expected behavior:** Describe your issue in detail 29 3. **Expected behavior:** Describe your issue in detail
28 4. **Observed behavior** 30 4. **Observed behavior**
29 -5. **Relevant logs and/or screen shots:** Please use code blocks (-5. **Relevant logs and/or screen -5. **Relevant logs and/or screen -5. **Relevant logs and/or screen ) to format console output, logs, and code as it's very hard to read otherwise. 31 +5. **Relevant logs and/or screenshots:** Please use code blocks (+5. **Relevant logs and/or screen+5. **Relevant logs and/or screen+5. **Relevant logs and/or screen) to format console output, logs, and code as it's very hard to read otherwise.
30 6. **Output of checks** 32 6. **Output of checks**
31 * 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 33 * 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
32 * 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) 34 * 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)
@@ -45,6 +47,7 @@ If you can, please submit a pull request with the fix or improvements including @@ -45,6 +47,7 @@ If you can, please submit a pull request with the fix or improvements including
45 1. Fork the project on GitHub 47 1. Fork the project on GitHub
46 1. Create a feature branch 48 1. Create a feature branch
47 1. Write [tests](README.md#run-the-tests) and code 49 1. Write [tests](README.md#run-the-tests) and code
  50 +1. Add your changes to the [CHANGELOG](CHANGELOG)
48 1. If you have multiple commits please combine them into one commit by [squashing them](http://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits) 51 1. If you have multiple commits please combine them into one commit by [squashing them](http://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits)
49 1. Push the commit to your fork 52 1. Push the commit to your fork
50 1. Submit a pull request 53 1. Submit a pull request
@@ -54,12 +57,13 @@ We will accept pull requests if: @@ -54,12 +57,13 @@ We will accept pull requests if:
54 57
55 * The code has proper tests and all tests pass (or it is a test exposing a failure in existing code) 58 * The code has proper tests and all tests pass (or it is a test exposing a failure in existing code)
56 * It can be merged without problems (if not please use: `git rebase master`) 59 * It can be merged without problems (if not please use: `git rebase master`)
57 -* It doesn't break any existing functionality 60 +* It does not break any existing functionality
58 * It's quality code that conforms to the [Ruby](https://github.com/bbatsov/ruby-style-guide) and [Rails](https://github.com/bbatsov/rails-style-guide) style guides and best practices 61 * It's quality code that conforms to the [Ruby](https://github.com/bbatsov/ruby-style-guide) and [Rails](https://github.com/bbatsov/rails-style-guide) style guides and best practices
59 * The description includes a motive for your change and the method you used to achieve it 62 * The description includes a motive for your change and the method you used to achieve it
  63 +* It is not a catch all pull request but rather fixes a specific issue or implements a specific feature
60 * It keeps the GitLab code base clean and well structured 64 * It keeps the GitLab code base clean and well structured
61 * We think other users will benefit from the same functionality 65 * We think other users will benefit from the same functionality
62 * If it makes changes to the UI the pull request should include screenshots 66 * If it makes changes to the UI the pull request should include screenshots
63 -* It is a single commit (please use git rebase -i to squash commits) 67 +* It is a single commit (please use `git rebase -i` to squash commits)
64 68
65 For examples of feedback on pull requests please look at already [closed pull requests](https://github.com/gitlabhq/gitlabhq/pulls?direction=desc&page=1&sort=created&state=closed). 69 For examples of feedback on pull requests please look at already [closed pull requests](https://github.com/gitlabhq/gitlabhq/pulls?direction=desc&page=1&sort=created&state=closed).