Contributing Guidelines¶
Here are some guidelines to help you get started:
Bug reports¶
If you find a bug, please create a new ticket (issue) in our bug tracker.
Creating an issue
Our project tracker is on GitHub, at this address: edu-framework/issues
Make sure to include:
- A clear, descriptive title
- The steps to reproduce the bug
- The expected behavior
- The actual behavior
- Any relevant logs or error messages
Feature requests¶
If you have an idea for a new feature, please create a new ticket (issue) in our bug tracker.
Creating an issue
Our project tracker is on GitHub, at this address: edu-framework/issues
Make sure to include:
- A clear, descriptive title
- A detailed description of the proposed feature
- Any relevant use cases or examples
- Any potential drawbacks or limitations
Pull Requests¶
Before submitting a pull request (PR), please make sure:
- That your code follows our coding standards (see below)
- That your changes are properly documented
- That you have added tests for any new feature
- That you have run all the existing tests and checked that they pass
Coding standards¶
Our project uses the PSR-2 coding standards. Please make sure your code follows these standards before submitting a pull request.
In addition, please make sure your code is well organized, easy to read and well commented.
Code quality checkers are in place to verify that the coding standards are followed.
- PHPStan: checks PHP code quality
- PHP Code Sniffer: checks PHP code quality
- PHP Mess Detector: checks PHP code quality
- PHPMD: checks PHP code quality
- SQLint: checks SQL code quality
- Trivy: checks dependency quality
Code quality dashboard
See the code quality dashboard: Quality Dashboard Codacy
Code of conduct¶
Our project follows the Code of conduct. Please read it before contributing to our project.
Thank you for your contributions!