📝 [DOC] Add details and template for pull request process

.github/pull_request_template.md

@@ -0,0 +1,29 @@
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Description
+
+<!--- Describe your changes in detail -->
+
+## Related Issue
+
+<!--- If suggesting a new feature or change, please discuss it in an issue first -->
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Please [link to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) here: -->
+
+## Checklist
+
+* [ ] I have followed the guidelines in our [Contributing document](https://geotrek.readthedocs.io/en/latest/CONTRIBUTING.html)
+- [ ] I have performed a self-review of my code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] I have added tests that prove my fix is effective or that my feature works.
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] I prefix my PR name with the corresponding tag
+- [ ] My commits are all using prefix convention
+- [ ] If my PR is still a work in progress I have marked it as "Draft"
+- [ ] I added an entry in the changelog file
+
+
+<!-- ⚠️ IMPORTANT : All new lines of code should be tested -->
+<!-- ⚠️ PR are always reviewed by at least one person before being merged -->
+<!-- Usually pull requests target the `master` branch on this repository -->

docs/CONTRIBUTING.rst

@@ -11,7 +11,7 @@ Conventions
 * Elegant and generic is good, simple is better
 * Separate bug fixes and new features in several pull requests.
 * Open a new Pull Request in "Draft" status until tests passed. Use at least 'bug', 'improvement' or 'feature' label.
-* Commits messages are explicit and mention issue number (``(ref #12)`` or ``(fixes #23)``)
+* Commits messages are explicit and mention issue number (``(ref #12)`` or ``(fixes #23)``), they should contains corresponding tag (see below)
 * Features are developed in a branch and merged from Github pull-requests.
 
 
@@ -33,6 +33,72 @@ Check TODO in the source tree:
    find geotrek | xargs egrep -n -i '(TODO|XXX|temporary|FIXME)'
 
 
+Pull requests
+-------------
+
+Before creating a pull request, ensure you follow thoses rules :
+
+* Follow the guidelines of this page
+* Self-review your code
+* Add comments in your code, particularly in hard-to-understand areas
+* Make corresponding changes to the documentation
+* There is tests that prove my fix is effective or that my feature works.
+* All new lines of code are tested
+* There is an entry in the changelog file
+
+Pull requests are following a naming convention in order to easily establish their perimeter. You can use one of those prefix:
+
++-----+---------------+-------+------------+---------+
+| Tag | Branch prefix | Emoji | Emoji code | Unicode |
++=====+===============+=======+============+=========+
+| Improvements | impr_ | :dizzy: | dizzy | 💫 |
++-----+---------------+-------+------------+---------+
+| Bug fixes | bug_ | :bug: | bug | 🐛 |
++-----+---------------+-------+------------+---------+
+| Features | feat_ | :sparkles: | sparkles | ✨ |
++-----+---------------+-------+------------+---------+
+| Documentation | doc_ | :pencil: | memo | 📝 |
++-----+---------------+-------+------------+---------+
+| Maintenance | maint_ | :construction_site: | building_construction | 🏗 |
++-----+---------------+-------+------------+---------+
+| Refactor | ref_ | :recycle: | recycle | ♻ | 
++-----+---------------+-------+------------+---------+
+| Dependencies | dep_ | :arrow_up: | arrow_up | ⬆ | 
++-----+---------------+-------+------------+---------+
+| CI/CD | cicd_ | :construction_worker: | construction_worker | 👷 |
++-----+---------------+-------+------------+---------+
+| Performances | perf_ | :zap: | zap | ⚡ |
++-----+---------------+-------+------------+---------+
+| Tooling | tool_ | :hammer: | hammer | 🔨 |
++-----+---------------+-------+------------+---------+
+| UI/UX | uiux_ | :lipstick: | lipstick | 💄 |
++-----+---------------+-------+------------+---------+
+| Security | sec_ | :lock: | lock | 🔒 | 
++-----+---------------+-------+------------+---------+
+| Translations | trans_ | :globe_with_meridians: | globe_with_meridians | 🌐 |
++-----+---------------+-------+------------+---------+
+| Hotfix | hot_ | :ambulance: | ambulance | 🚑 |
++-----+---------------+-------+------------+---------+
+| Breaking change | break_ | :boom: | boom | 💥 |
++-----+---------------+-------+------------+---------+
+
+Tags used only for commits:
+
++-----------+-------+-----+
+| Tag | Emoji | Emoji code |
++===========+=======+=====+
+| Codestyle | :art: | art |
++-----------+-------+-----+
+| Clean | :fire: | fire |
++-----------+-------+-----+
+| Tests | :white_check_mark: | white_check_mark |
++-----------+-------+-----+
+| Release | :bookmark: | bookmark |
++-----------+-------+-----+
+| Merge | :twisted_rightwards_arrows: | twisted_rightwards_arrows |
++-----------+-------+-----+
+
+
 Release
 -------
 

docs/changelog.rst

@@ -25,6 +25,7 @@ CHANGELOG
 **Documentation**
 
 - Add configuration file for readthedocs
+- Add details and template for the pull requests process
 
 
 2.99.0 (2023-07-18)