Thank you for considering contributing to the docs.datenschmutz.dev! Your help is essential in keeping the website up-to-date and accurate. There are many ways you can contribute, whether it's reporting a bug, improving the documentation, or implementing a new feature.
The goal of our website is to create a general knowledge collection about general IT topics. we would be very happy about your help! But what we don't want is to become a copy&paste collection. Of course, many things are already very well described on the Internet, so we ask you to create a doc only if you can better describe, explain or expand the content.
There are several options to contribute to the website, if you want to:
-
Report bugs and request features: If you find a bug or have an idea for a new feature, you can open an GitHub Issues in the repository. Be sure to include as much information as possible, including steps to reproduce the bug (if applicable) or details about the proposed feature. If you are reporting a bug, please include your operating system, browser, and version information.
-
Fix bugs and implement features: If you have the skills and knowledge to fix a bug or implement a feature, you can submit a pull request. Before submitting your pull request, be sure to read the contribution guidelines (below) and follow the coding style of the project.
-
Improve documentation: If you see a problem with the documentation on the website, you can submit a pull request to fix it. This includes typos, formatting issues, and outdated information. If you are making significant changes to the documentation, please consider opening an GitHub Issues first to discuss your proposed changes.
-
Help with translation: If you are fluent in a language other than English, you can help us translate the documentation into multiple languages. If you are interested in contributing translations, please reach out to us through the repository's GitHub Issues tracker.
-
Contributing an idea via GitHub Issues - we take over the implementation if we like the idea.
Before submitting a pull request, please make sure you have read and understand the following guidelines:
- Check the existing open Issues and pull requests to make sure someone hasn't already addressed the problem you are trying to solve or the feature you are trying to implement.
- Follow the coding style of the project. This includes indentation, naming conventions, and commenting practices.
- Test any new code you contribute.
- Make sure all tests pass before submitting your pull request.
We have decided to create and maintain our website according to the Contributor Covenant Code of Conduct, the corresponding version of which can be found on the website itself and here on GitHub. We ask you to follow these guidelines when creating content!
If you encounter an error or bug please use the GitHub Issues function and use the appropriate template.
When opening a new issue, always make sure to fill out the issue template. This step is important! If you omit this, it may cost us time to gather additional information and your issue may be closed if the effort is too high. Don't take this personally if this happens, and feel free to open a new issue once you've gathered all the information required by the template.
Please don't use the GitHub issue function for questions. If you have questions use GitHub Discussions to ask.
the core of our website is right here on GitHub all changes made via commit or pull request merge in the main branch are live on the web within a few seconds.
By contributing to docs.datenschmutz.dev, you agree to release your contributions under the MIT License.
Thank you for considering contributing to the docs.datenschmutz.dev! We appreciate any and all contributions, no matter how small. Your help is essential in keeping the website up-to-date and accurate.