Skip to content

Commit 3eee346

Browse files
axilleasaxilleas
committed
Move contributing guidelines to separate file
1 parent 2c31ba6 commit 3eee346

File tree

2 files changed

+102
-72
lines changed

2 files changed

+102
-72
lines changed

‎README.md

Lines changed: 7 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,16 @@
1-
gitlab-recipes
2-
==============
1+
## GitLab recipes: unofficial guides for using GitLab with different software
32

4-
Unofficial guides for using GitLab with different software (operating systems, webservers, etc.)
3+
Here you will find unofficial guides for using GitLab with different software (operating systems, web servers, etc.)
54
provided by the community, for systems other than the officially supported (Debian/Ubuntu).
65

76
Bare in mind that this repository is co-maintained by volunteers/contributors like you.
87

9-
# Contributing
8+
## Contributing
109

11-
## Naming guidelines
10+
See [contributing.md](contributing.md) for contribution guidelines.
1211

13-
For better maintainance and clarity, some naming guidelines should be followed.
12+
## Notes on the reliability of guides/scripts
1413

15-
* Installation guides should be provided in README files so that they render first when viewing the repository.
16-
17-
* Installation scripts reside in a `scripts/` directory inside every platform folder.
18-
19-
### Scripts
20-
21-
There are scripts doing similar things
22-
23-
? Scripts should be named after the following scheme: platform-platform_version
24-
Example: `ubuntu-server-12.04.sh`
25-
26-
## Install information
27-
28-
If you have an installation guide to provide, fill in the template and place it on top
29-
of your guide or include it in your installation script (commented), again on top.
30-
31-
### Template
32-
33-
```
34-
Distribution :
35-
GitLab version :
36-
Web Server :
37-
Init system :
38-
Database :
39-
Contributor :
40-
Additional Notes :
41-
```
42-
43-
### Explanation
44-
45-
| Label | Explanation |
46-
| ---------------- | ------------------------- |
47-
| Distribution | The official name and version of the platform/distribution, case sensitive. |
48-
| GitLab version | GitLab version on which the guide/script was tested. |
49-
| Web Server | The web server used to serve GitLab. May be two-fold, eg. apache with mod_passenger. |
50-
| Init system | (Optional but recommended) The init system used by the platform if any. Examples: `sysvinit`, `systemd`, `upstart`, `openrc`, etc |
51-
| Database | The database used for installation. Examples: `mysql`, `postrgres`, `mariadb`.
52-
| Contributor | Your github username (recommended in order to track you and give credits) or your real name or both. Example of the latter: **thedude (Jeffrey Lebowski)** |
53-
| Additional Notes | Anything else you want to add. Any deviations form the official guide can be reported here. Eg. using rvm for ruby install, storing in different locations, etc.|
54-
55-
56-
### Example
57-
58-
```
59-
Distribution : Fedora 19
60-
GitLab version : 5.4
61-
Web Server : apache with mod_passenger
62-
Init system : systemd
63-
Database : mariadb
64-
Contributor : thedude
65-
Additional Notes : the script uses rvm to install ruby
66-
```
67-
68-
### Accepting Pull Requests
69-
70-
Please stick as close as possible to the guidelines. That way we ensure quality guides
71-
and easy to merge requests.
72-
73-
Your Pull Request will be reviewed by one of our volunteers and you will be
74-
asked to reformat it if needed. We don't bite and we will try to be as flexible
75-
as possible, so don't get intimidated by the extent of the quidelines :)
76-
77-
## Notes
78-
79-
* We try to test everything before accepting PRs, in a clean, newly installed platform.
14+
* We will try to test everything before accepting PRs, in a clean, newly installed platform.
8015
* You should read a script and understand what it does prior to running it.
81-
* If something goes wrong during installation and you think the guide/script needs fixing, file a bug report or a Pull Request.
16+
* If something goes wrong during installation and you think the guide/script needs fixing, file a bug report or a submit a Pull Request.

‎contributing.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# Contribute to GitLab recipes
2+
3+
This guide details how to use issues and pull requests to improve GitLab recipes.
4+
5+
Please stick as close as possible to the guidelines. That way we ensure quality guides
6+
and easy to merge requests.
7+
8+
Your Pull Request will be reviewed by one of our devs/volunteers and you will be
9+
asked to reformat it if needed. We don't bite and we will try to be as flexible
10+
as possible, so don't get intimidated by the extent of the quidelines :)
11+
12+
For better maintainance and clarity, some naming guidelines should be followed.
13+
See details in each section below.
14+
15+
## Pull Request title
16+
17+
Try to be as more descriptive as you can in your Pull Request title.
18+
19+
Particularly if you are submitting a new script or guide, include in the title,
20+
information about GitLab version, OS tested on and any other relevant info.
21+
22+
For example some good titles would be:
23+
24+
* [Installation script] GitLab 6.x - Ubuntu 12.04 - Apache
25+
* [Guide] GitLab 6.1 - FreeBSD - postrges, rvm
26+
27+
## Guides
28+
29+
Each installation guide has its own namespace and it should be provided in a
30+
`README` file so that it renders first when viewing the repository. Submit a new
31+
one in `install/platform/README.md` (it doesn't have to be strictly in markdown though).
32+
33+
## Scripts
34+
35+
Installation scripts reside in `install/platform/scripts/`, so if you have one,
36+
submit it there. They should named after the following scheme: `platform-platform_version`.
37+
38+
Example: `ubuntu-server-12.04.sh`
39+
40+
You are strongly encouraged to also provide a `README` file that describes
41+
how to use the script. You may have included all the needed info in the script
42+
itself (recommended), so you could simply write something between the lines:
43+
44+
> This script installs GitLab 6.0 on Archlinux. Run it with `./archlinux.sh your_domain_name`
45+
> For more info and variables you can change, read the comments in the script.
46+
47+
48+
### Scripts doing similar things
49+
50+
There is a strong possibility that your script will do similar things to what a
51+
script already in this repo do. In that case, please work on the existing script
52+
and enhance it with your changes. No need to duplicate things.
53+
54+
## What information to put on your guide/script etc (mandatory)
55+
56+
If you have an installation guide to provide, fill in the template and place it on top
57+
of it or include it in your installation script (commented), again on top. Try to
58+
include as many items of this template as you can.
59+
60+
### Template
61+
62+
```
63+
Distribution :
64+
GitLab version :
65+
Web Server :
66+
Init system :
67+
Database :
68+
Contributor :
69+
Additional Notes :
70+
```
71+
72+
### Explanation
73+
74+
| Label | Explanation |
75+
| ---------------- | ------------------------- |
76+
| Distribution | The official name and version of the platform/distribution, case sensitive. |
77+
| GitLab version | GitLab version on which the guide/script was tested. |
78+
| Web Server | The web server used to serve GitLab. May be two-fold, eg. apache with mod_passenger. |
79+
| Init system | (Optional but recommended) The init system used by the platform if any. Examples: `sysvinit`, `systemd`, `upstart`, `openrc`, etc |
80+
| Database | The database used for installation. Examples: `mysql`, `postrgres`, `mariadb`.
81+
| Contributors | Your github username (recommended in order to track you and give credits) or your real name or both. Example of the latter: **thedude (Jeffrey Lebowski)** |
82+
| Additional Notes | Anything else you want to add. Any deviations form the official guide can be reported here. Eg. using rvm for ruby install, storing in different locations, etc.|
83+
84+
85+
### Example
86+
87+
```
88+
Distribution : Fedora 19
89+
GitLab version : 5.4
90+
Web Server : apache with mod_passenger
91+
Init system : systemd
92+
Database : mariadb
93+
Contributors : thedude
94+
Additional Notes : the script uses rvm to install ruby
95+
```

0 commit comments

Comments
 (0)