Skip to content

Commit 768a871

Browse files
authored
Contributor Guide entry in the docs (#60)
* Contributor Guide entry in the docs * Add more description * Add pre-requisites
1 parent 006dd75 commit 768a871

File tree

3 files changed

+52
-0
lines changed

3 files changed

+52
-0
lines changed

.config/dictionary.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
libera

docs/contributor_guide.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributor Guide
2+
3+
To contribute to `ansible-dev-tools` python package or to the list of tools part of it, please use pull requests on a branch of your own fork.
4+
5+
After [creating your fork on GitHub], you can do:
6+
7+
```shell-session
8+
$ git clone --recursive git@github.com:your-name/developer-tool-name
9+
$ cd developer-tool-name
10+
$ git checkout -b your-branch-name
11+
# DO SOME CODING HERE
12+
$ git add your new files
13+
$ git commit -v
14+
$ git push origin your-branch-name
15+
```
16+
17+
You will then be able to create a pull request from your commit.
18+
19+
Prerequisites:
20+
21+
1. All fixes to core functionality (i.e. anything except docs or examples) should
22+
be accompanied by tests that fail prior to your change and succeed afterwards.
23+
24+
2. Before sending a PR, make sure that `tox -e lint` passes.
25+
26+
Feel free to raise issues in the repo if you feel unable to contribute a code
27+
fix.
28+
29+
## Talk to us
30+
31+
Use Github [discussions] forum or for a live chat experience try
32+
`#ansible-devtools` IRC channel on libera.chat or Matrix room
33+
[#devtools:ansible.com](https://matrix.to/#/#devtools:ansible.com).
34+
35+
For the full list of Ansible IRC and Mailing list, please see the [Ansible
36+
Communication] page. Release announcements will be made to the [Ansible
37+
Announce] list.
38+
39+
Possible security bugs should be reported via email to
40+
<mailto:security@ansible.com>.
41+
42+
## Code of Conduct
43+
44+
Please see the official [Ansible Community Code of Conduct].
45+
46+
[discussions]: https://github.com/ansible/ansible-dev-tools/discussions
47+
[ansible communication]: https://docs.ansible.com/ansible/latest/community/communication.html
48+
[ansible announce]: https://groups.google.com/forum/#!forum/ansible-announce
49+
[Ansible Community Code of Conduct]: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
50+
[creating your fork on github]: https://docs.github.com/en/get-started/quickstart/contributing-to-projects

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ nav:
4545
- Introduction: introduction.md
4646
- Installation: installation.md
4747
- Getting Started: getting_started.md
48+
- Contributor Guide: contributor_guide.md
4849

4950
plugins:
5051
- autorefs

0 commit comments

Comments
 (0)