Download as
Browse Code »

Commit fe6d122d23d2bfab16aedf0774fa57e964a0fcdf

Authored by Dmitriy Zaporozhets
2 parents 11452c90 bcd001f2
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

Merge pull request #1785 from dosire/update-developer-documentation 

Refer developers to the vagrant vm and remove out of date documentation.
Showing 2 changed files with 23 additions and 36 deletions   Show diff stats
CONTRIBUTING.md
  Diff comments   View file @fe6d122
1   -## Contribute to GitLab
  1 +## Contribute to GitLab
2 2  
3 3 If you want to contribute to GitLab, follow this process:
4 4  
... ... @@ -7,24 +7,20 @@ If you want to contribute to GitLab, follow this process:
7 7 3. Code
8 8 4. Create a pull request
9 9  
10   -We will only accept pull requests if:
  10 +We will only accept pull requests if:
11 11  
12 12 * Your code has proper tests and all tests pass
13   -* Your code can be merged w/o problems
  13 +* Your code can be merged w/o problems
14 14 * It won't break existing functionality
15 15 * It's quality code
16 16 * We like it :)
17 17  
18   -## [You may need a developer VM](https://github.com/gitlabhq/developer-vm)
  18 +For examples of feedback on pull requests please look at the [closed pull requests](https://github.com/gitlabhq/gitlabhq/pulls?direction=desc&page=1&sort=created&state=closed).
19 19  
20   -## Running tests
21   -
22   -To run the specs for GitLab, you need to run seeds for test db.
  20 +## Installation
23 21  
24   - cd gitlabhq
25   - rake db:seed_fu RAILS_ENV=test
  22 +Install the Gitlab development in a virtual machine with the [Gitlab Vagrant virtual machine](https://github.com/gitlabhq/gitlab-vagrant-vm). Installing it in a virtual machine makes it much easier to set up all the dependencies for integration testing.
26 23  
27   -Then you can run the test suite with rake:
28   -
29   - rake gitlab:test
  24 +## Running tests
30 25  
  26 +For more information on running the tests please read the [development tips](https://github.com/gitlabhq/gitlabhq/blob/master/doc/development.md)
... ...
doc/development.md
  Diff comments   View file @fe6d122
1   -## Development tips:
  1 +## Development tips:
2 2  
3   -### Start application in development mode
4 3  
5   -#### 1. Via foreman
  4 +### Installation
6 5  
7   - bundle exec foreman -p 3000
  6 +Install the Gitlab development in a virtual machine with the [Gitlab Vagrant virtual machine](https://github.com/gitlabhq/gitlab-vagrant-vm). Installing it in a virtual machine makes it much easier to set up all the dependencies for integration testing.
8 7  
9   -#### 2. Via gitlab cli
10 8  
11   - ./gitlab start
  9 +### Start application in development mode
12 10  
13   -#### 3. Manually
  11 +#### 1. Via gitlab cli
14 12  
15   - bundle exec rails s
16   - bundle exec rake environment resque:work QUEUE=* VVERBOSE=1
  13 + ./gitlab start
17 14  
  15 +#### 2. Manually
18 16  
19   -### Run tests:
20   -
21   -#### 1. Packages
  17 + bundle exec rails s
  18 + bundle exec rake environment resque:work QUEUE=* VVERBOSE=1
22 19  
23   - # ubuntu
24   - sudo apt-get install libqt4-dev libqtwebkit-dev
25   - sudo apt-get install xvfb
26   -
27   - # Mac
28   - brew install qt
29   - brew install xvfb
30 20  
31   -#### 2. DB & seeds
  21 +### Test DB seutup & seed
32 22  
33 23 bundle exec rake db:setup RAILS_ENV=test
34 24 bundle exec rake db:seed_fu RAILS_ENV=test
35 25  
36   -### 3. Run Tests
  26 +
  27 +### Run the Tests
37 28  
38 29 # All in one
39 30 bundle exec rake gitlab:test
40   -
41   - # Rspec
  31 +
  32 + # Rspec
42 33 bundle exec rake spec
43   -
  34 +
44 35 # Spinach
45 36 bundle exec rake spinach
... ...