From 768a871de3098025b8346cc2534098d49e626a83 Mon Sep 17 00:00:00 2001
From: Shatakshi Mishra <shatakshimishra01@gmail.com>
Date: Tue, 5 Dec 2023 19:28:26 +0530
Subject: [PATCH] Contributor Guide entry in the docs (#60)

* Contributor Guide entry in the docs

* Add more description

* Add pre-requisites
---
 .config/dictionary.txt    |  1 +
 docs/contributor_guide.md | 50 +++++++++++++++++++++++++++++++++++++++
 mkdocs.yml                |  1 +
 3 files changed, 52 insertions(+)
 create mode 100644 docs/contributor_guide.md

diff --git a/.config/dictionary.txt b/.config/dictionary.txt
index e69de29b..0e41165c 100644
--- a/.config/dictionary.txt
+++ b/.config/dictionary.txt
@@ -0,0 +1 @@
+libera
diff --git a/docs/contributor_guide.md b/docs/contributor_guide.md
new file mode 100644
index 00000000..d7cd5efc
--- /dev/null
+++ b/docs/contributor_guide.md
@@ -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
diff --git a/mkdocs.yml b/mkdocs.yml
index 87cf7caa..a0686d8e 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -45,6 +45,7 @@ nav:
   - Introduction: introduction.md
   - Installation: installation.md
   - Getting Started: getting_started.md
+  - Contributor Guide: contributor_guide.md
 
 plugins:
   - autorefs