-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathCONTRIBUTING
75 lines (55 loc) · 2.27 KB
/
CONTRIBUTING
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# Contributing
:wave: Hi there! We're thrilled that you'd like to contribute to this project.
Your help is essential for keeping it great.
## Submitting a Pull Request
Pull requests (PRs) are used for adding new playbooks, roles, and documents to
the repository, or editing the existing ones.
### With Write Access
1. Clone the repository
1. Create a new branch
```bash
git checkout -b my-branch-name
```
1. Commit your changes
1. Push your branch
1. Open a PR
1. Pat yourself on the back and wait for your pull request to be reviewed and
merged!
### Without Write Access
1. Fork and clone the repository
1. Create a new branch
```bash
git checkout -b my-branch-name
```
1. Commit your changes
1. Push your branch to your fork
1. Navigate to this repository on GitHub.com
1. Open a PR
1. Pat your self on the back and wait for your pull request to be reviewed and
merged!
Here are a few things you can do that will increase the likelihood of your pull
request being accepted:
- Keep your change as focused as possible. If there are multiple changes you
would like to make that are not dependent upon each other, consider submitting
them as separate pull requests.
- Write
[good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
_Work in Progress_ pull requests are also welcome to get feedback early on, or
if there is something blocking you.
- Create a branch with a name that identifies the user and nature of the changes
(similar to `user/branch-purpose`)
- Open a pull request and request a review from the
`@ActionsDesk/services-delivery` team
## Releasing
If you are the current maintainer of this action:
1. Create a
[Tag](https://stackoverflow.com/questions/18216991/create-a-tag-in-a-github-repository)
2. Draft
[Release](https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository)
document explaining details of Release
3. Look for approval from
[CODEOWNERS](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners)
## Resources
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
- [GitHub Help](https://help.github.com)