From 5a8cb16f8f91f3f6755d93971aaa0d2b38e42a7e Mon Sep 17 00:00:00 2001 From: Dan Paulat Date: Tue, 7 Mar 2023 23:28:14 -0600 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..ea551cca --- /dev/null +++ b/CONTRIBUTING.md @@ -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!