deac/gitlabhq
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

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

Browse source 
Update Contribution Guide
This commit is contained in:
Dmitriy Zaporozhets 2012-12-20 10:46:57 -08:00
parent 1dcf19c924 691799a3fe
commit d8d95c85ae
2 changed files with 13 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
CONTRIBUTING.md
View file

@ -1,32 +1,26 @@
## Usage & Configuration
# Contact & support
Do you have a question related to usage or configuration, please head over to the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq).
If you want quick help, head over to our [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq).
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.
## Contribute to GitLab
# Contribute to GitLab
If you want to contribute to GitLab, follow this process:
## Recipes
1. Fork the project
2. Create a feature branch
3. Code
4. Create a pull request
We collect user submitted installation scripts and config file templates for platforms we don't support officially.
We believe there is merit in allowing a certain amount of diversity.
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.
We will only accept pull requests if:
Help us improve the collection of [GitLab Recipes](https://github.com/gitlabhq/gitlab-recipes/)
* Your code has proper tests and all tests pass
* Your code can be merged w/o problems
* It won't break existing functionality
* It's quality code
* We like it :)
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).
## Feature suggestions
## Installation
Follow the [Issue Submission Guide](https://github.com/gitlabhq/gitlabhq/wiki/Issue-Submission-Guide) and support other peoples ideas or propose your own.
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.
## Running tests
## Code
For more information on running the tests please read the [development tips](https://github.com/gitlabhq/gitlabhq/blob/master/doc/development.md)
Follow our [Developer Guide](https://github.com/gitlabhq/gitlabhq/wiki/Developer-Guide) to set you up for hacking on GitLab.

36
doc/development.md
View file

@ -1,36 +0,0 @@
## Development tips:
### Installation
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.
### Start application in development mode
#### 1. Via foreman
bundle exec foreman start -p 3000
#### 2. Manually
bundle exec rails s
bundle exec rake environment resque:work QUEUE=* VVERBOSE=1
### Test DB setup & seed
bundle exec rake db:setup RAILS_ENV=test
bundle exec rake db:seed_fu RAILS_ENV=test
### Run the Tests
# All in one
bundle exec rake gitlab:test
# Rspec
bundle exec rake spec
# Spinach
bundle exec rake spinach