Download as
Browse Code »

Commit 69159634d616ab1b40f053eda7847a40c98d0943

Authored by Dmitriy Zaporozhets
2 parents 5b4032d1 6e908f1a
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

Merge pull request #3125 from dosire/development-doc-in-repo 

Development doc in repo
Showing 2 changed files with 75 additions and 7 deletions   Show diff stats
CONTRIBUTING.md
  Diff comments   View file @6915963
... ... @@ -29,12 +29,32 @@ 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. Starting point would be the [Developer Guide](https://github.com/gitlabhq/gitlabhq/wiki/Developer-Guide)
  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 +
  34 +1. Fork the project on GitHub
  35 +1. Create a feature branch
  36 +1. Write tests and code
  37 +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)
  38 +1. Push the commit to your fork
  39 +1. Submit a pull request
  40 +
  41 +We will accept pull requests if:
  42 +
  43 +* The code has proper tests and all tests pass
  44 +* It can be merged without problems (if not please use: git rebase master)
  45 +* It doesn't break any existing functionality
  46 +* It's quality code that conforms to the [Rails style guide](https://github.com/bbatsov/rails-style-guide) and best practices
  47 +* The description includes a motive for your change and the method you used to achieve it
  48 +* It keeps the GitLab code base clean and well structured
  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 +
  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).
33 53  
34 54 ## Submitting via GitHub's issue tracker
35 55  
36 56 * For obvious bugs or misbehavior in GitLab in the master branch. Please include the revision id and a reproducible test case.
37   -* For problematic or insufficient documentation. Please include a suggestion to improve it.
  57 +* For problematic or insufficient documentation. Please give a suggestion on how to improve it.
38 58  
39 59 If you're unsure where to post, post it to the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) first.
40 60 There are a lot of helpful GitLab users there who may be able to help you quickly.
... ...
README.md
  Diff comments   View file @6915963
... ... @@ -43,7 +43,9 @@
43 43  
44 44 * More details are in the [requirements doc](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/requirements.md)
45 45  
46   -### Getting started
  46 +### Installation
  47 +
  48 +You can either follow the "ordinary" Installation guide to install it on a machine or use the Vagrant virtual machine. The Installation guide is recommended to set up a production server. The Vargrant virtual machine is recommended for development since it makes it much easier to set up all the dependencies for integration testing.
47 49  
48 50 * [Installation guide for latest stable release](https://github.com/gitlabhq/gitlabhq/blob/4-2-stable/doc/install/installation.md)
49 51  
... ... @@ -51,13 +53,43 @@
51 53  
52 54 * [Vagrant virtual machine](https://github.com/gitlabhq/gitlab-vagrant-vm)
53 55  
54   -* [Developer guide](https://github.com/gitlabhq/gitlabhq/wiki/Developer-Guide)
  56 +### Starting
55 57  
56   -* [Upgrade guides](https://github.com/gitlabhq/gitlabhq/wiki)
  58 +1. The Installation guide contains instructions to download an init script and run that on boot. With the init script you can also start GitLab with:
57 59  
58   -* [Roadmap](https://github.com/gitlabhq/gitlabhq/blob/master/ROADMAP.md)
  60 +> sudo service gitlab start
59 61  
60   -* [GitLab API](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/README.md)
  62 +or
  63 +
  64 +> sudo /etc/init.d/gitlab restart
  65 +
  66 +2. Start it with [Foreman](https://github.com/ddollar/foreman) in development model
  67 +
  68 +bundle exec foreman start -p 3000
  69 +
  70 +3. Start it manually in development mode
  71 +
  72 +> bundle exec rails s
  73 +> bundle exec rake sidekiq:start
  74 +
  75 +### Running the tests
  76 +
  77 +* Seed the database with
  78 +
  79 +> bundle exec rake db:setup RAILS_ENV=test
  80 +> bundle exec rake db:seed_fu RAILS_ENV=test
  81 +
  82 +* Run all tests
  83 +
  84 +> bundle exec rake gitlab:test
  85 +
  86 +* Rspec unit and functional tests
  87 +
  88 +> bundle exec rake spec
  89 +
  90 +* Spinach integration tests
  91 +
  92 +> bundle exec rake spinach
61 93  
62 94 ### Getting help
63 95  
... ... @@ -71,6 +103,22 @@
71 103  
72 104 * [Paid services](http://blog.gitlab.com/services/)
73 105  
  106 +### New versions and the API
  107 +
  108 +Each month on the 22th a new version is released together with an upgrade guide.
  109 +
  110 +* [Upgrade guides](https://github.com/gitlabhq/gitlabhq/wiki)
  111 +
  112 +* [Roadmap](https://github.com/gitlabhq/gitlabhq/blob/master/ROADMAP.md)
  113 +
  114 +### Other documentation
  115 +
  116 +* [GitLab API](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/README.md)
  117 +
  118 +* [Rake tasks](https://github.com/gitlabhq/gitlabhq/tree/master/doc/raketasks)
  119 +
  120 +* [GitLab recipes](https://github.com/gitlabhq/gitlab-recipes)
  121 +
74 122 ### Getting in touch
75 123  
76 124 * [Contributing guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md)
... ...