Skip to content

Commit

Permalink
Contributor Guide entry in the docs (#60)
Browse files Browse the repository at this point in the history
* Contributor Guide entry in the docs

* Add more description

* Add pre-requisites
  • Loading branch information
shatakshiiii authored Dec 5, 2023
1 parent 006dd75 commit 768a871
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 0 deletions.
1 change: 1 addition & 0 deletions .config/dictionary.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
libera
50 changes: 50 additions & 0 deletions docs/contributor_guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Contributor Guide

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.

After [creating your fork on GitHub], you can do:

```shell-session
$ git clone --recursive git@github.com:your-name/developer-tool-name
$ cd developer-tool-name
$ git checkout -b your-branch-name
# DO SOME CODING HERE
$ git add your new files
$ git commit -v
$ git push origin your-branch-name
```

You will then be able to create a pull request from your commit.

Prerequisites:

1. All fixes to core functionality (i.e. anything except docs or examples) should
be accompanied by tests that fail prior to your change and succeed afterwards.

2. Before sending a PR, make sure that `tox -e lint` passes.

Feel free to raise issues in the repo if you feel unable to contribute a code
fix.

## Talk to us

Use Github [discussions] forum or for a live chat experience try
`#ansible-devtools` IRC channel on libera.chat or Matrix room
[#devtools:ansible.com](https://matrix.to/#/#devtools:ansible.com).

For the full list of Ansible IRC and Mailing list, please see the [Ansible
Communication] page. Release announcements will be made to the [Ansible
Announce] list.

Possible security bugs should be reported via email to
<mailto:security@ansible.com>.

## Code of Conduct

Please see the official [Ansible Community Code of Conduct].

[discussions]: https://github.com/ansible/ansible-dev-tools/discussions
[ansible communication]: https://docs.ansible.com/ansible/latest/community/communication.html
[ansible announce]: https://groups.google.com/forum/#!forum/ansible-announce
[Ansible Community Code of Conduct]: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
[creating your fork on github]: https://docs.github.com/en/get-started/quickstart/contributing-to-projects
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ nav:
- Introduction: introduction.md
- Installation: installation.md
- Getting Started: getting_started.md
- Contributor Guide: contributor_guide.md

plugins:
- autorefs
Expand Down

0 comments on commit 768a871

Please sign in to comment.