Skip to content

Commit 4a3470f

Browse files
Add PR Template
1 parent 8ee371d commit 4a3470f

File tree

2 files changed

+62
-0
lines changed

2 files changed

+62
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# How to contribute
2+
3+
Feel free to:
4+
5+
- [Create an issue](https://help.github.com/articles/creating-an-issue/)
6+
- [Make a pull request](https://services.github.com/on-demand/github-cli/open-pull-request-github) into the `develop` branch
7+
8+
Here is how you can help, a lot of steps are related to GitHub, not specifically my roles.
9+
10+
## 1. Create an issue
11+
12+
When you see some issue or have an idea for improvement, [create an issue](https://github.com/monolithprojects/ansible-github_actions_runner/issues).
13+
14+
## 2. Fork the project
15+
16+
Click on `fork` on the top-right corner and fork the repository.
17+
18+
## 3. Make the changes
19+
20+
Do dthe changes in your own GitHub namespace.
21+
22+
## 4. Test the changes
23+
24+
**Note:** I will test the role again, so you don't need to do that if you don't want to.
25+
26+
Install [molecule](https://molecule.readthedocs.io/en/stable/) and run the test:
27+
28+
```bash
29+
pip install molecule molecule-docker ansible-lint docker
30+
cd ansible-github_actions_runner
31+
molecule test
32+
```
33+
34+
> You will need to edit the files in `molecule/default` directory (please do not commit those changes)
35+
36+
## 5. Create a pull request
37+
38+
Please create a pull request into the `develop` branch. Here is [how to do it](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
39+
40+
Please consider to [sponsor](https://github.com/sponsors/monolithprojects) me :-)

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Pull Request Template
2+
3+
## Description
4+
5+
Please include a summary of the change and which issue is fixed.
6+
7+
## Type of change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] This change requires a documentation update
15+
16+
## How Has This Been Tested?
17+
18+
Please describe the tests that you ran to verify your changes.
19+
20+
## Destination branch
21+
22+
Create PR to merge your changes into `develop` branch

0 commit comments

Comments
 (0)