diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3184cc0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing to StackRender + +We appreciate your interest in contributing to StackRender. Your contributions, whether small or significant, help make the project better for everyone. + +## Ways to Contribute + +### 1. Submitting Pull Requests +To contribute code or documentation: +1. **Fork** the repository. +2. **Create a new branch** from `main`, focusing on one change at a time. +3. Write clear and descriptive commit messages. +4. Ensure your code follows the project’s style guidelines and passes any checks. +5. Open a pull request explaining: + - The issue it addresses. + - The reasoning behind your solution. +6. Wait for review and respond to any feedback. + +### 2. Reporting Bugs +If you find a bug: +- Check the [GitHub Issues](https://github.com/stackrender/stackrender/issues) to see if it has already been reported. +- If not, open a **new bug report** and include: + - Steps to reproduce the problem. + - Expected and actual results. + - Any relevant logs or screenshots. + +### 3. Suggesting Features +If you have an idea for improvement: +- Open a **feature request** in the issues section. +- Describe the feature and explain why it would be useful. +- You may also discuss ideas with the community on [Discord](https://discord.gg/DsN8RcPR6Y). + +## License Agreement +By contributing, you agree that your work will be licensed under the **GNU Affero General Public License v3.0**. + +## Questions or Support +If you have questions about the contribution process, open a discussion on GitHub or reach out on our [Discord](https://discord.gg/DsN8RcPR6Y).