Download as
Browse Code »

Commit 5421f6b239fcf2742e6190ee6ffdaa6144ab800a

Authored by Sytse Sijbrandij
1 parent 56d1cc5b
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

Small fixes and better quoting.

Showing 2 changed files with 26 additions and 17 deletions   Show diff stats
CONTRIBUTING.md
  Diff comments   View file @5421f6b
... ... @@ -29,7 +29,7 @@ Feature suggestions don't belong in issues but can go to [Feedback forum](http:/
29 29  
30 30 ## Pull requests
31 31  
32   -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:
  32 +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:
33 33  
34 34 1. Fork the project on GitHub
35 35 1. Create a feature branch
... ... @@ -41,15 +41,15 @@ Code speaks louder than words. If you can please submit a pull request with the
41 41 We will accept pull requests if:
42 42  
43 43 * The code has proper tests and all tests pass
44   -* It can be merged without problems (if not please use: git rebase master to fix this)
45   -* It won't break any existing functionality
  44 +* It can be merged without problems (if not please use: git rebase master)
  45 +* It doesn't break any existing functionality
46 46 * It's quality code that conforms to the [Rails style guide](https://github.com/bbatsov/rails-style-guide) and best practices
47   -* You describe your PR properly please give a motive for your change and the method you used to achieve it
  47 +* The description includes a motive for your change and the method you used to achieve it
48 48 * It keeps the GitLab code base clean and well structured
49   -* We think other users need the same functionality
50   -* If it makes changes to the UI it should have screen shots
  49 +* We think other users will need the same functionality
  50 +* If it makes changes to the UI the pull request should include screenshots
51 51  
52   -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).
  52 +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).
53 53  
54 54 ## Submitting via GitHub's issue tracker
55 55  
... ...
README.md
  Diff comments   View file @5421f6b
... ... @@ -57,36 +57,39 @@ You can either follow the "ordinary" Installation guide to install it on a machi
57 57  
58 58 1. The Installation guide contains instructions to download an init script and run that on boot. After configuring the init script you can run
59 59  
60   -sudo service gitlab start
  60 +> sudo service gitlab start
61 61  
62 62 or
63 63  
64   -sudo /etc/init.d/gitlab restart
  64 +> sudo /etc/init.d/gitlab restart
65 65  
66   -2. With [foreman](https://github.com/ddollar/foreman)
  66 +2. Start it with [Foreman](https://github.com/ddollar/foreman)
67 67  
68 68 bundle exec foreman start -p 3000
69 69  
70 70 3. Start it manually
71 71  
72   -bundle exec rails s
73   -bundle exec rake environment resque:work QUEUE=* VVERBOSE=1
  72 +> bundle exec rails s
  73 +> bundle exec rake environment resque:work QUEUE=* VVERBOSE=1
74 74  
75 75 ### Running the tests
76 76  
77 77 * Seed the database with
78 78  
79   -bundle exec rake db:setup RAILS_ENV=test
80   -bundle exec rake db:seed_fu RAILS_ENV=test
  79 +> bundle exec rake db:setup RAILS_ENV=test
  80 +> bundle exec rake db:seed_fu RAILS_ENV=test
81 81  
82 82 * Run all tests
83   -bundle exec rake gitlab:test
  83 +
  84 +> bundle exec rake gitlab:test
84 85  
85 86 * Rspec unit and functional tests
86   -bundle exec rake spec
  87 +
  88 +> bundle exec rake spec
87 89  
88 90 * Spinach integration tests
89   -bundle exec rake spinach
  91 +
  92 +> bundle exec rake spinach
90 93  
91 94 ### Getting help
92 95  
... ... @@ -108,8 +111,14 @@ Each month on the 22th a new version is released together with an upgrade guide.
108 111  
109 112 * [Roadmap](https://github.com/gitlabhq/gitlabhq/blob/master/ROADMAP.md)
110 113  
  114 +### Other documentation
  115 +
111 116 * [GitLab API](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/README.md)
112 117  
  118 +* [Rake tasks](https://github.com/gitlabhq/gitlabhq/tree/master/doc/raketasks)
  119 +
  120 +* [GitLab recipes](https://github.com/gitlabhq/gitlab-recipes)
  121 +
113 122 ### Getting in touch
114 123  
115 124 * [Contributing guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md)
... ...