Download as
Browse Code »

Commit d8d95c85aea31a3814c7c9910a4bf429510ec481

Authored by Dmitriy Zaporozhets
2 parents 1dcf19c9 691799a3
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

Merge pull request #2321 from riyad/update-contrib-docs 

Update Contribution Guide
Showing 2 changed files with 13 additions and 55 deletions   Show diff stats
CONTRIBUTING.md
  Diff comments   View file @d8d95c8
1   -## Usage & Configuration
  1 +# Contact & support
2 2  
3   -Do you have a question related to usage or configuration, please head over to the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq).
  3 +If you want quick help, head over to our [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq).
  4 +Otherwise you can follow our [Issue Submission Guide](https://github.com/gitlabhq/gitlabhq/wiki/Issue-Submission-Guide) for a more systematic and thorough guide to solving your issues.
4 5  
5 6  
6 7  
7   -## Contribute to GitLab
  8 +# Contribute to GitLab
8 9  
9   -If you want to contribute to GitLab, follow this process:
  10 +## Recipes
10 11  
11   -1. Fork the project
12   -2. Create a feature branch
13   -3. Code
14   -4. Create a pull request
  12 +We collect user submitted installation scripts and config file templates for platforms we don't support officially.
  13 +We believe there is merit in allowing a certain amount of diversity.
  14 +You can get and submit your solution to running/configuring GitLab with your favorite OS/distro, database, web server, cloud hoster, configuration management tool, etc.
15 15  
16   -We will only accept pull requests if:
  16 +Help us improve the collection of [GitLab Recipes](https://github.com/gitlabhq/gitlab-recipes/)
17 17  
18   -* Your code has proper tests and all tests pass
19   -* Your code can be merged w/o problems
20   -* It won't break existing functionality
21   -* It's quality code
22   -* We like it :)
23 18  
24   -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 +## Feature suggestions
25 20  
26   -## Installation
  21 +Follow the [Issue Submission Guide](https://github.com/gitlabhq/gitlabhq/wiki/Issue-Submission-Guide) and support other peoples ideas or propose your own.
27 22  
28   -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.
29 23  
30   -## Running tests
  24 +## Code
31 25  
32   -For more information on running the tests please read the [development tips](https://github.com/gitlabhq/gitlabhq/blob/master/doc/development.md)
  26 +Follow our [Developer Guide](https://github.com/gitlabhq/gitlabhq/wiki/Developer-Guide) to set you up for hacking on GitLab.
... ...
doc/development.md
View file @1dcf19c
... ... @@ -1,36 +0,0 @@
1   -## Development tips:
2   -
3   -
4   -### Installation
5   -
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.
7   -
8   -
9   -### Start application in development mode
10   -
11   -#### 1. Via foreman
12   -
13   - bundle exec foreman start -p 3000
14   -
15   -#### 2. Manually
16   -
17   - bundle exec rails s
18   - bundle exec rake environment resque:work QUEUE=* VVERBOSE=1
19   -
20   -
21   -### Test DB setup & seed
22   -
23   - bundle exec rake db:setup RAILS_ENV=test
24   - bundle exec rake db:seed_fu RAILS_ENV=test
25   -
26   -
27   -### Run the Tests
28   -
29   - # All in one
30   - bundle exec rake gitlab:test
31   -
32   - # Rspec
33   - bundle exec rake spec
34   -
35   - # Spinach
36   - bundle exec rake spinach