CONTRIBUTING.md

How to contribute

✨ Thank you for taking the time to contribute to this project!

🤝 Everyone is encouraged to participate, as long as you engage with consideration and respect and contribute in a positive and constructive way.

🪪 This project is released under the MIT License.

🏁 First see the README to have an overview of the project and to install it.

Reporting a problem: good issues

🔎 If you spot a problem that should be fixed or have an idea to enhance the app, please first check if there is still an issue about it.

Issues can relate to fixing a bug, improving the code quality or the app performance, adding a new test or creating a new feature, enhancing the documentation... anything you may consider appropriate.

💡 If the issue doesn't exist yet, please create it, writing a relevant title and clear explanations about your suggestion.

Using the labels (and also creating some if useful) can be convenient to help collaborating on the project. Also providing as much context as you can may be very helpful, such as: screen shots, link to documentation, and of course, specifying which file(s) should be updated / which feature would be impacted by the change.

Making changes: quality process

You can solve an existing issue or solve the ones you created

Please take official documentation, coding conventions and quality recommandations into account

• PSR standards: https://www.php-fig.org/psr/
• Symfony coding standards: https://symfony.com/doc/current/contributing/code/standards.html#making-your-code-follow-the-coding-standards
• Symfony best practices: https://symfony.com/doc/current/best_practices.html#creating-the-project
• PHPUnit documentation: https://phpunit.de/documentation.html

The project is also linked to Codacy and CodeClimate , both being helpful to check if your code is good enough or needs some improvements before being sent to the project.

Commit your changes regularly on the dev branch.

When you're finished, create a Pull Request to submit your code.** It will first be reviewed and then merged to the main branch (maybe after some corrections). Don't forget to link it to the related issue!

Improvements suggestions

• Add a reset password feature and make it accessible to the admins and the account's owner
• Enhance the front-end adding relevant spaces and good quality pictures
• Fix deprecations (see Web Profiler) and prepare to upgrade to Symfony 6
• Increase and improve the test coverage adding object validation
• ... make your own suggestions by creating issues!