Thank you for considering contributing to the STORM (Software Troubleshooting Online Resource Manual) project! We welcome contributions from the community to help improve and expand the troubleshooting guide for various devices under Linux, Windows, and non-standard OS environments.
To contribute, please follow these guidelines:
- Fork the repository and create a new branch for your contributions.
- Make your changes and improvements to the content.
- Ensure that your changes adhere to the markdown syntax and follow the existing structure.
- If you are adding a new device or troubleshooting information, use the provided device template or update it accordingly.
- Provide clear and concise explanations for the troubleshooting steps, including any code snippets or commands.
- Ensure that any external sources or references used are properly credited in the "Sources" section.
- Test your changes to ensure they are accurate and effective.
- Commit your changes and submit a pull request.
The STORM guide is also available as a GitBook hosted at storm.novadelta.tk. The GitBook is automatically generated from the content in this GitHub repository.
To update the GitBook with your contributions, follow these steps:
- Submit your pull request with the desired changes to the repository.
- Once your pull request is merged, the GitBook will be automatically updated within a few minutes.
Please note that due to the automated process, it may take some time for the GitBook to reflect the changes made in the repository.
Please note that this project follows the Contributor Covenant Code of Conduct. We expect all contributors to adhere to the code of conduct in all project interactions.
If you have any questions or need assistance with contributing, feel free to reach out by creating an issue or contacting the project maintainers.
We appreciate your contributions and look forward to your help in making STORM an even better resource for troubleshooting various devices under different operating systems!