diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1ca89dbbe204..cff5e939f119 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ Feature suggestions don't belong in issues but can go to [Feedback forum](http:/ ## Pull requests -Code speaks louder than words. If you can please submit a pull request with the fix including tests. The workflow to make a pull request is a follows: +Code speaks louder than words. If you can please submit a pull request with the fix including tests. The workflow to make a pull request is as follows: 1. Fork the project on GitHub 1. Create a feature branch @@ -41,15 +41,15 @@ Code speaks louder than words. If you can please submit a pull request with the We will accept pull requests if: * The code has proper tests and all tests pass -* It can be merged without problems (if not please use: git rebase master to fix this) -* It won't break any existing functionality +* It can be merged without problems (if not please use: git rebase master) +* It doesn't break any existing functionality * It's quality code that conforms to the [Rails style guide](https://github.com/bbatsov/rails-style-guide) and best practices -* You describe your PR properly please give a motive for your change and the method you used to achieve it +* The description includes a motive for your change and the method you used to achieve it * It keeps the GitLab code base clean and well structured -* We think other users need the same functionality -* If it makes changes to the UI it should have screen shots +* We think other users will need the same functionality +* If it makes changes to the UI the pull request should include screenshots -For examples of feedback on pull requests please look at our already [closed pull requests](https://github.com/gitlabhq/gitlabhq/pulls?direction=desc&page=1&sort=created&state=closed). +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). ## Submitting via GitHub's issue tracker diff --git a/README.md b/README.md index 327d495ab7d3..e6cb3e4b24d3 100644 --- a/README.md +++ b/README.md @@ -57,36 +57,39 @@ You can either follow the "ordinary" Installation guide to install it on a machi 1. The Installation guide contains instructions to download an init script and run that on boot. After configuring the init script you can run -sudo service gitlab start +> sudo service gitlab start or -sudo /etc/init.d/gitlab restart +> sudo /etc/init.d/gitlab restart -2. With [foreman](https://github.com/ddollar/foreman) +2. Start it with [Foreman](https://github.com/ddollar/foreman) bundle exec foreman start -p 3000 3. Start it manually -bundle exec rails s -bundle exec rake environment resque:work QUEUE=* VVERBOSE=1 +> bundle exec rails s +> bundle exec rake environment resque:work QUEUE=* VVERBOSE=1 ### Running the tests * Seed the database with -bundle exec rake db:setup RAILS_ENV=test -bundle exec rake db:seed_fu RAILS_ENV=test +> bundle exec rake db:setup RAILS_ENV=test +> bundle exec rake db:seed_fu RAILS_ENV=test * Run all tests -bundle exec rake gitlab:test + +> bundle exec rake gitlab:test * Rspec unit and functional tests -bundle exec rake spec + +> bundle exec rake spec * Spinach integration tests -bundle exec rake spinach + +> bundle exec rake spinach ### Getting help @@ -108,8 +111,14 @@ Each month on the 22th a new version is released together with an upgrade guide. * [Roadmap](https://github.com/gitlabhq/gitlabhq/blob/master/ROADMAP.md) +### Other documentation + * [GitLab API](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/README.md) +* [Rake tasks](https://github.com/gitlabhq/gitlabhq/tree/master/doc/raketasks) + +* [GitLab recipes](https://github.com/gitlabhq/gitlab-recipes) + ### Getting in touch * [Contributing guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md)