Thank you for your interest in contributing to HardView! Your help is valuable in making this library robust, fast, and reliable across all supported platforms.
- Try HardView on various systems (Windows 32/64-bit, Linux x86/x86_64, different Python versions).
- Report any issues you encounter, especially those related to installation, import, or hardware detection.
- Share your results and environment details (OS, Python version, hardware specs).
- If you find a bug, please open an issue on GitHub.
- Include:
- Clear description of the problem
- Steps to reproduce
- Your OS, Python version, and HardView version
- Any error messages or logs
- If you have an idea for a new feature or improvement, open an issue with the "enhancement" label.
- Describe the use case and why it would be helpful.
- Fork the repository and create a new branch for your changes.
- Follow the existing code style (C99 for C code, PEP8 for Python code).
- Add or update documentation and tests as needed.
- Make sure your code builds and passes all tests on supported platforms.
- Submit a pull request with a clear description of your changes.
- If you run performance tests or use HardView in a real project, share your results and scripts.
- This helps others understand the library's capabilities and performance.
- Improve or expand the documentation (in
docs/). - Add new examples, clarify existing sections, or translate docs to other languages.
- C code: Use C99 standard, 4-space indentation, and clear, descriptive names.
- Python code: Follow PEP8.
- Write comments for complex logic and public functions.
- Keep functions small and focused.
- (If available) Run the provided test scripts to verify your changes.
- Test on as many platforms and Python versions as possible.
- If you have questions about contributing, open an issue or start a discussion on GitHub.
Thank you for helping make HardView better!