Skip to content

Commit 263b202

Browse files
cmeissnercmeissner
committed
Add contributing and documentation things
* add github issue templates * add contribution inforamation * link all together in documentations * fine tune documentation index file * fine tune documentation generation via makefile
1 parent 30ad46c commit 263b202

File tree

8 files changed

+106
-19
lines changed

8 files changed

+106
-19
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
<!-- list of steps to reproduce the feature -->
16+
17+
**Expected behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Versions:**
21+
22+
- python
23+
- phpypam
24+
25+
**Additional context**
26+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎CONTRIBUTING.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# How to contribute to phpipam-ansible-modules
2+
3+
## Did you found a bug
4+
5+
* Do not open Github issue it the bug concerns [{php}IPAM](https://github.com/phpipam/phpipam) and not the ansible modules.
6+
7+
* Make sure the bug is not already opened by another user.
8+
9+
* 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=).
10+
11+
* Provide as much information as mentioned in the bug report template.
12+
13+
## Did you wrote a patch for an open bug
14+
15+
* Open new pull request containing the patch.
16+
17+
* Provide a clear description which describes the problem and the solution. Link the existing bug to the PR.
18+
19+
## Do you want to add a new feature
20+
21+
* Make sure there isn't already a feature request.
22+
23+
* 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=).
24+
25+
* Suggest your feature idea within the created feature request.
26+
27+
* Provide as much discribtion as possible to enable others to have a good understanding of what you are doing.
28+
29+
* Point out that you want to start to work on the new feature
30+
31+
## Do you wnat to contribute to documentation
32+
33+
* Write you documentation change.
34+
35+
* Open a PR with your change.
36+
37+
* Discuss with the team about your changes.
38+
39+
## Thank you for any contribution
40+
41+
We will thank you for heed the contribution guidelines and we encourage you to contribute and join the team.

‎Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ doc-setup:
4444

4545
doc:
4646
install -d -m 750 ./docs/plugins
47-
sphinx-apidoc -o docs/plugins/ phpypam
47+
sphinx-apidoc -M -f -o docs/plugins/ phpypam
4848
make -C docs html
4949

5050
FORCE:

‎docs/CONTRIBUTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../CONTRIBUTING.md

‎docs/index.rst

+7-2
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,17 @@ Welcome to phpypam's documentation!
88

99
.. toctree::
1010
:maxdepth: 2
11-
:caption: Contents:
11+
:caption: User documentation
1212

1313
README
14-
plugins/phpypam
14+
Changelog <CHANGELOG>
1515
plugins/modules
1616

17+
.. toctree::
18+
:maxdepth: 2
19+
:caption: Developer documentation
20+
21+
Contributing <CONTRIBUTING>
1722

1823

1924
Indices and tables

‎docs/plugins/phpypam.core.rst

+5-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
phpypam.core package
22
====================
33

4+
.. automodule:: phpypam.core
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
49
Submodules
510
----------
611

@@ -19,11 +24,3 @@ phpypam.core.exceptions module
1924
:members:
2025
:undoc-members:
2126
:show-inheritance:
22-
23-
Module contents
24-
---------------
25-
26-
.. automodule:: phpypam.core
27-
:members:
28-
:undoc-members:
29-
:show-inheritance:

‎docs/plugins/phpypam.rst

+5-8
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
11
phpypam package
22
===============
33

4+
.. automodule:: phpypam
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
49
Subpackages
510
-----------
611

712
.. toctree::
813
:maxdepth: 4
914

1015
phpypam.core
11-
12-
Module contents
13-
---------------
14-
15-
.. automodule:: phpypam
16-
:members:
17-
:undoc-members:
18-
:show-inheritance:

0 commit comments

Comments
 (0)