@@ -20,6 +20,31 @@ The [gitlab-mirrors](https://github.com/sag47/gitlab-mirrors) project is designe
2. [Install gitlab-mirrors](docs/installation.md)
3. [Manage your mirrors](docs/management.md)
*Note:if you are upgrading then see `docs/upgrade` for notes on upgrading.*
---
# Get help
There are a couple ways you can try to get help. You can [file an issue](https://github.com/sag47/gitlab-mirrors/issues). You can also join the `#gitlab` IRC channel at freenode.net and direct your questions to user `sag47`.
## IRC Etiquette
* I generally stay logged in to freenode so be sure to mention my handle when you're asking questions so that I see it in the `#gitlab` channel.
* If I don't answer right away then just hang out in the channel or do other stuff with your life. I will eventually write back to you as it just means I'm away from my keyboard, working on something else, or in a different timezone than you.
* You should treat IRC as what it is: asynchronous chat. Sure the messages can be instant but in most channels people are in different time zones so coming in and demanding help and then leaving immediately will not get your problem solved.
---
# Contributing
I enjoy contributions and encourage them! You should add your code to my project and make your mark. I only make a few simple requests in order to contribute.
*Test your own work before submitting a pull request. Most of this project is bash code so we do not have the luxury of a test driven frame work to assist our development. Needless to say I will be sure to test it myself before it ever makes it into a production release.
*Create a feature branch with a name that does not exist in any of my branches (e.g. `feature/myfeature` or `feature-cool_feature`). This is where you should do your development. This will allow you to integrate my development with your own and ease integrating updated code if we're both concurrently developing.
*When your feature is ready make a pull request to the *development* branch. Pull requests to the master branch will not be accepted. The master branch is intended to drive production systems and only stable production-ready commits will be made to it.
