2.8 KiB
Please contribute
You can really make a difference by:
- Making an issue. A well described issue helps a lot. (Have a look at the known issues.)
- Making a pull request when you see the error in code.
I'll try to help and take every contribution seriously.
It's a great opportunity for me to learn how you use the role and also an opportunity to get into the habit of contributing to open source software.
Step by step
Here is how you can help, a lot of steps are related to GitHub, not specifically my roles.
1. Make an issue.
When you spot an issue, create an issue.
Making the issue help me and others to find similar problems in the future.
2. Fork the project.
On the top right side of the repository on GitHub, click fork. This copies everything to your GitHub namespace.
3. Make the changes
In you own GitHub namespace, make the required changes.
I typically do that by cloning the repository (in your namespace) locally:
git clone git@github.com:YOURNAMESPACE/ansible-role-bootstrap.git
Now you can start to edit on your laptop.
4. Optionally: test your changes
pip install molecule tox ansible-lint docker
And run molecule test. If you want to test a specific distribution, set image and optionally tag:
image=centos tag=7 molecule test
Once it start to work, you can test multiple version of Ansible:
image=centos tag=7 tox
5. Optionally: Regenerate all dynamic content
You can use Ansible Generator to regenerate all dynamic content.
If you don't do it, I'll do it later for you.
6. Make a pull request
GitHub on pull requests.
In the comment-box, you can refer to the issue number by using #123, where 123 is the issue number.
7. Wait
Now I'll get a message that you've added some code. Thank you, really.
CI starts to test your changes. You can follow the progress on Travis.
Please consider sponsoring me.