Create CONTRIBUTING.md

This commit is contained in:
Dan Paulat 2023-03-07 23:28:14 -06:00 committed by GitHub
parent e8b0868b55
commit 5a8cb16f8f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

43
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,43 @@
# Supercell Wx Contribution Guidelines
Thank you for considering contributing to Supercell Wx! We welcome all kinds of contributions, from bug reports to feature requests to code contributions.
## Code of Conduct
Before contributing, please read and adhere to the [code of conduct](CODE_OF_CONDUCT.md).
## Contributing
To contribute to Supercell Wx, please follow these steps:
1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes and commit them with a descriptive message.
4. Push your changes to your fork.
5. Create a pull request to the main repository.
### Issues
If you encounter a problem or want to suggest a new feature, please open an issue on GitHub. When opening an issue, please include:
- Steps to reproduce the problem
- System details
- Operating system and version
- Graphics hardware and driver version
- Memory usage
- Network speed and latency
- Debug log contents (if applicable)
### Code Contributions
When contributing code, please follow these guidelines:
- Use the Clang-Format profile.
- Use the [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html).
- Write descriptive commit messages.
- Write clear and concise code with comments where necessary.
- Add tests for new features or bug fixes.
Please note that code contributions may be subject to modifications of the license by the project maintainer.
Thank you for considering contributing to Supercell Wx!