Skip to content
Snippets Groups Projects
Commit 59d59bee authored by Zeger-Jan van de Weg's avatar Zeger-Jan van de Weg
Browse files

Add README

parent f5fb495f
No related branches found
No related tags found
No related merge requests found
# A collection of `.gitlab-ci.yml` templates
This is GitLabs collection of [`.gitlab-ci.yml`][ci-docs] file templates, to be used
in conjunction with [GitLab CI][gl-ci].
This list is used to populate the `.gitlab-ci.yml` template choosers available
on all GitLab instances running 8.9 or later.
For more information about how `.gitlab-ci.yml` files work, and how to use them,
please read the [documentation on GitLab CI][ci-docs]. Please keep in mind that
these templates might need editing to suit your setup, and should be considered
guideline.
[ci-docs]: http://docs.gitlab.com/ce/ci/
[gl-ci]: https://about.gitlab.com/gitlab-ci/
## Folder structure
The files in the root directory are for `.gitlab-ci.yml` templates that are
project specific, such as language or framework specific templates.
The Pages folder holds `gitlab-ci.yml` templates to be used with [GitLab Pages][gl-pages].
[gl-pages][http://docs.gitlab.com/ee/pages/README.html]
## Contributing guidelines
We’d love you to help us improve this project. To help us keep this collection
high quality, we request that contributions adhere to the following guidelines.
- **Provide a link to the application or project’s homepage**. Unless it’s
extremely popular, there’s a chance the maintainers don’t know about or use
the language, framework, editor, app, or project your change applies to.
- **Provide links to documentation** supporting the change you’re making. If it's
possible to provide a build trace, please provide this.
- **Explain why you’re making a change**. Even if it seems self-evident, please
take a sentence or two to tell us why your change or addition should happen.
It’s especially helpful to articulate why this change applies to *everyone*
who works with the applicable technology, rather than just you or your team.
- **Please consider the scope of your change**. If your change specific to a
certain language or framework, then make sure the change is made to the
template for that language or framework, rather than to the template for an
editor, tool, or operating system.
- **Please only modify *one template* per merge request**. This helps keep merge
requests and feedback focused on a specific project or technology.
In general, the more you can do to help us understand the change you’re making,
the more likely we’ll be to accept your contribution quickly.
Please also understand that we can’t list every tool that ever existed.
Our aim is to curate a collection of the *most common and helpful* templates,
not to make sure we cover every project possible. If we choose not to
include your language, or project, it’s not because it’s not awesome.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment