To contribute to this project, don't push directly to this repository.
Instead, please fork this repository then make pull requests.
Please follow this simple rules for your pull requests :
- Try to always make explicit commit messages in english
- Preffer multiple small atomic commits over a big one
- If an issue already exists concerning you request, indicate it in your commit
If you are a GIT beginner and need advises, please follow our guide.
We don't use specific syntax rules, but, for clarity, try to follow this recommendations :
- Services names and OBM module names a in CamelCase
- When using changed state tracking, variables, by default, are called command_result
- A task must have a name
- A task must have at least a tag
- Tags represents the role or, if role is common, a functionnality
- Command module is better than shell module
- Using a module is better than using a command
- Using changed state tracking is better than using handlers
- Variables are written in lowercase and use underscores to separate words
- If you variable is a configuration key, place it in group_vars/all
- If your variable is specific to a group and will never been update by users, place it in group_vars/your_group
- If your variable is specific to a role and will never been update by users, place it role/you_role/vars
To make your lives better, respect following rules before creating a new issue :
- Ensure you followed our installation procedure
- Be sure that all dependencies for your role are satisfied (common ?)
- Be sure your problem can be reproduced and indicate how we can do it
- Provide us all usefull infos abour your environment (inventory file, configuration variables, ...)
If you need support, please use OBM mailing-list.