gitadmin
/
ansible-generator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Markdown anchors.

This commit is contained in:
Robert de Bock 2020-06-04 20:38:39 +02:00
parent 958da8f561
commit e8b743a5c3
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
templates/CONTRIBUTING.md.j2
View File

@ -1,4 +1,4 @@
# Please contribute
# [Please contribute](#please-contribute)
You can really make a difference by:
@ -9,21 +9,21 @@ 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
## [Step by step](#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.
### [1. Make an issue.](#1-make-an-issue)
When you spot an issue, [create an issue](https://github.com/{{ github_namespace }}/{{ role_name }}/issues).
Making the issue help me and others to find similar problems in the future.
### 2. Fork the project.
### [2. Fork the project.](#2-fork-the-project)
On the top right side of [the repository on GitHub](https://github.com/{{ github_namespace }}/{{ role_name }}), click `fork`. This copies everything to your GitHub namespace.
### 3. Make the changes
### [3. Make the changes](#3-make-the-changes)
In you own GitHub namespace, make the required changes.
@ -35,7 +35,7 @@ git clone git@github.com:YOURNAMESPACE/{{ role_name }}.git
Now you can start to edit on your laptop.
### 4. Optionally: test your changes
### [4. Optionally: test your changes](#4-optionally-test-your-changes)
Install [molecule](https://molecule.readthedocs.io/en/stable/) and [Tox](https://tox.readthedocs.io/):
@ -55,19 +55,19 @@ Once it start to work, you can test multiple version of Ansible:
image=centos tag=7 tox
```
### 6. Optionally: Regenerate all dynamic content
### [5. Optionally: Regenerate all dynamic content](#5-optionally-regenerate-all-dynamic-content)
You can use [Ansible Generator](https://github.com/robertdebock/ansible-generator) to regenerate all dynamic content.
If you don't do it, I'll do it later for you.
### 7. Make a pull request
### [6. Make a pull request](#6-make-a-pull-request)
[GitHub](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) on pull requests.
In the comment-box, you can [refer to the issue number](https://help.github.com/en/github/writing-on-github/autolinked-references-and-urls) by using #123, where 123 is the issue number.
### 8. Wait
### [7. Wait](#7-wait)
Now I'll get a message that you've added some code. Thank you, really.

6
templates/SECURITY.md.j2
View File

@ -1,8 +1,8 @@
# Security Policy
# [Security Policy](#security-policy)
This software implements other software, it's not very likely that this software introduces new vulnerabilities.
## Supported Versions
## [Supported Versions](#supported-versions)
The current major version is supported. For example if the current version is 3.4.1:
@ -14,7 +14,7 @@ The current major version is supported. For example if the current version is 3.
| 2.0.0 | :x: |
| 1.0.0 | :x: |
## Reporting a Vulnerability
## [Reporting a Vulnerability](#reporting-a-vulnarability)
Please [open an issue](https://github.com/{{ github_namespace }}/ansible-role-{{ role_name }}/issues) describing the vulnerability.