diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3778e13 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing to Edux + +Thank you for your interest in contributing to Edux! Here's how you can help: + +## Reporting Issues + +- Check existing issues for your problem, duplicate reports can create extra work. +- If no existing issue exists, create a new one, providing detailed information. + +## Submitting Code Changes + +1. **Fork the repository** and create your branch from `main`. +2. **Make your changes**: Ensure they are clear, concise, and adhere to our coding standards. Add comments to clarify complex code sections. +3. **Write or adapt tests** as needed to reflect your changes. +4. **Commit your changes**: Use a clear and descriptive commit message. +5. **Submit a Pull Request** with comprehensive request message. + +## Code Standards + +- Stick to Java coding conventions. +- Keep code clean and readable. +- Ensure all tests are passing. + +## Communication + +Quick questions? Problem to discuss? Open a GitHub discussion right now. + +**Your contributions keep the Edux project alive and thriving. Thank you!**