Merge contributor & developer guide

Signed-off-by: Christian Berendt <[email protected]>
osism · Jan 15, 2025 · f5252bb · f5252bb
1 parent 091e178
commit f5252bb
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 18 deletions.
diff --git a/docs/guides/developer-guide/index.md b/docs/guides/developer-guide/index.md
@@ -5,6 +5,19 @@ sidebar_position: 60
 
 # Developer Guide
 
+We welcome any issues, change requests or general feedback. Do not hestiate to [open an issue](https://github.com/osism/issues/issues/new).
+
+We use GitHub Issues to capture feature requests, feedback, bugs, etc. The tracker is available in the
+[osism/issues](https://github.com/osism/issues/issues) repository. There are no specific requirements for the creation of an issue.
+Error cases should be described in such a way that they are directly reproducible. The more outputs there are,
+the better.
+
+We use GitHub pull requests for contributions. The use of pull requets is documented in the
+official [GitHub documentation](https://docs.github.com/en/github/collaborating-with-pull-requests).
+The process in detail for the creation of a fork, branch etc. is also documented in the
+official [GitHub documentation](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests).
+It is recommended to use the [GitHub CLI](https://cli.github.com). Makes many steps easier.
+
 ## How to add a new service
 
 If you want to add a new service to OSISM, this is done via an Ansible role and (most often)

diff --git a/docs/guides/other-guides/contributor-guide.md b/docs/guides/other-guides/contributor-guide.md