codeaffen · cmeissner · Oct 30, 2020 · Oct 30, 2020
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+<!-- list of steps to reproduce the feature -->
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Versions:**
+
+- python
+- phpypam
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,41 @@
+# How to contribute to phpipam-ansible-modules
+
+## Did you found a bug
+
+* Do not open Github issue it the bug concerns [{php}IPAM](https://github.com/phpipam/phpipam) and not the ansible modules.
+
+* Make sure the bug is not already opened by another user.
+
+* If you can't find an open issue which reflects your observed problem go ahead an [open a new bug](https://github.com/codeaffen/phpypam/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
+
+* Provide as much information as mentioned in the bug report template.
+
+## Did you wrote a patch for an open bug
+
+* Open new pull request containing the patch.
+
+* Provide a clear description which describes the problem and the solution. Link the existing bug to the PR.
+
+## Do you want to add a new feature
+
+* Make sure there isn't already a feature request.
+
+* If you can't find an open feature request which describe your feature idea or parts of it feel free to [open a new feature request](https://github.com/codeaffen/phpypam/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=).
+
+* Suggest your feature idea within the created feature request.
+
+* Provide as much discribtion as possible to enable others to have a good understanding of what you are doing.
+
+* Point out that you want to start to work on the new feature
+
+## Do you wnat to contribute to documentation
+
+* Write you documentation change.
+
+* Open a PR with your change.
+
+* Discuss with the team about your changes.
+
+## Thank you for any contribution
+
+We will thank you for heed the contribution guidelines and we encourage you to contribute and join the team.
diff --git a/Makefile b/Makefile
@@ -44,7 +44,7 @@ doc-setup:
 
 doc:
 	install -d -m 750 ./docs/plugins
-	sphinx-apidoc -o docs/plugins/ phpypam
+	sphinx-apidoc -M -f -o docs/plugins/ phpypam
 	make -C docs html
 
 FORCE:

diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -0,0 +1 @@
+../CONTRIBUTING.md
diff --git a/docs/index.rst b/docs/index.rst
@@ -8,12 +8,17 @@ Welcome to phpypam's documentation!
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :caption: User documentation
 
    README
-   plugins/phpypam
+   Changelog <CHANGELOG>
    plugins/modules
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Developer documentation
+
+   Contributing <CONTRIBUTING>
 
 
 Indices and tables

diff --git a/docs/plugins/phpypam.core.rst b/docs/plugins/phpypam.core.rst
@@ -1,6 +1,11 @@
 phpypam.core package
 ====================
 
+.. automodule:: phpypam.core
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Submodules
 ----------
 
@@ -19,11 +24,3 @@ phpypam.core.exceptions module
    :members:
    :undoc-members:
    :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: phpypam.core
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/plugins/phpypam.rst b/docs/plugins/phpypam.rst
@@ -1,18 +1,15 @@
 phpypam package
 ===============
 
+.. automodule:: phpypam
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Subpackages
 -----------
 
 .. toctree::
    :maxdepth: 4
 
    phpypam.core
-
-Module contents
----------------
-
-.. automodule:: phpypam
-   :members:
-   :undoc-members:
-   :show-inheritance: