|
| 1 | +# Contributing to CodeJudge |
| 2 | + |
| 3 | +Thank you for your interest in contributing to **CodeJudge**! Your help is appreciated, whether you are reporting bugs, suggesting features, improving documentation, or submitting code. |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## How to Contribute |
| 8 | + |
| 9 | +### 1. Reporting Bugs |
| 10 | +- Please [open an issue](../../issues) and provide as much detail as possible: |
| 11 | + - Steps to reproduce the bug |
| 12 | + - Expected behavior |
| 13 | + - Actual behavior |
| 14 | + - Device, OS and the version of your OS |
| 15 | + - Screenshots if applicable |
| 16 | + |
| 17 | +### 2. Suggesting Features |
| 18 | +- [Open an issue](../../issues) and use the "Feature request" label. |
| 19 | +- Clearly explain your idea and its benefits. |
| 20 | +- If possible, describe how it could be implemented. |
| 21 | + |
| 22 | +### 3. Improving Documentation |
| 23 | +- Feel free to submit pull requests to improve the README or other documentation. |
| 24 | +- Fixing typos, clarifying instructions, and adding examples are all welcome. |
| 25 | + |
| 26 | +### 4. Code Contributions |
| 27 | + |
| 28 | +#### Getting Started |
| 29 | +- Fork this repository. |
| 30 | +- Clone your fork to your local machine. |
| 31 | +- Create a new branch for your feature or fix. |
| 32 | + |
| 33 | +#### Checklist |
| 34 | +- Write clear, descriptive commit messages. |
| 35 | +- Follow the project’s code style (C as backend & Flutter/Dart as frontend) if possible. |
| 36 | +- Test your changes before submitting. |
| 37 | +- Do **not** commit files generated by your IDE (e.g., `.idea/`). |
| 38 | + |
| 39 | +#### Submitting a Pull Request |
| 40 | +- Push your branch to your fork. |
| 41 | +- Open a pull request against the `main` branch. |
| 42 | +- Describe your changes and reference related issues if applicable. |
| 43 | + |
| 44 | +--- |
| 45 | + |
| 46 | +## Code of Conduct |
| 47 | + |
| 48 | +Please be respectful and considerate in your communications and contributions. All interactions must follow the [GitHub Community Guidelines](https://docs.github.com/en/site-policy/github-terms/github-community-guidelines). |
| 49 | + |
| 50 | +--- |
| 51 | + |
| 52 | +## License |
| 53 | + |
| 54 | +By contributing, you agree that your contributions will be licensed under the Apache 2.0 License. |
| 55 | + |
| 56 | +## Attribution |
| 57 | + |
| 58 | +If you fork and redistribute CodeJudge, please include the following attribution in your README or documentation: |
| 59 | + |
| 60 | +> Based on CodeJudge by Fabian Roland (naibaf-1) |
| 61 | +
|
| 62 | +--- |
| 63 | + |
| 64 | +Thank you for helping improve CodeJudge! |
0 commit comments