gitlabhq/CONTRIBUTING.md

33 lines
1.1 KiB
Markdown
Raw Normal View History

2012-12-10 12:15:51 +01:00
## Usage & Configuration
Do you have a question related to usage or configuration, please head over to the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq).
## Contribute to GitLab
2012-09-17 19:42:18 +02:00
2012-09-17 20:38:08 +02:00
If you want to contribute to GitLab, follow this process:
2012-09-17 19:42:18 +02:00
1. Fork the project
2. Create a feature branch
3. Code
4. Create a pull request
We will only accept pull requests if:
2012-09-17 19:42:18 +02:00
* 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
2012-09-17 19:42:18 +02:00
* 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).
2012-09-17 19:42:18 +02:00
## Installation
2012-09-17 19:42:18 +02:00
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.
2012-09-17 19:42:18 +02:00
## Running tests
2012-09-17 19:42:18 +02:00
For more information on running the tests please read the [development tips](https://github.com/gitlabhq/gitlabhq/blob/master/doc/development.md)