Merge pull request #6 from argos-ci/github_templates

feat: add github templates

Author: jsfez

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +1,37 @@
 ---
 name: Bug report
-about: Create a report to help us improve
-title: ''
+about: Report a bug that you encounter
+title: "Bug: "
 labels: bug
-assignees: ''
-
+assignees: ""
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+## Bug description
+
+Describe the bug, context and use case.
+
+### Correct behavior expected
+
+Describe the correct behavior you expect to happen if there is no bug.
+
+### Wrong behavior observed
+
+Describe the wrong behavior that happen because of the bug.
+
+### Screenshot
+
+_Optional:_ Add a screenshot to help explain the problem.
+
+## Reproduce
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+Describe a way to reproduce the bug.
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+You can share a code snippet or give a step by step guide.
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+## Setup
 
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+Describe the setup you have when you encounter the bug : device, browser, library version...
 
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+## Additional information
 
-**Additional context**
-Add any other context about the problem here.
+Add any other information that can help us understand the bug or fix it.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +1,15 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
+title: "Feat: "
+labels: "enhancement"
+assignees: ""
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+<!-- Rephrase the feature as a user story format : -->
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+As a [user|client|developer], I would like to ...
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+## Description
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+Describe the feature, context and use case.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+## Description
+
+Please explain the changes you made here.
+
+## Type of changes
+
+Select the correct labels: `bug`, `enhancement` or `documentation`.
+
+## Checklist
+
+Valid all before asking for a code review to `argos-ci/code` :
+
+- [ ] I have read the CONTRIBUTING doc
+- [ ] The commits message follows the [Conventional Commits' policy](https://www.conventionalcommits.org/)
+- [ ] Lint and unit tests pass locally
+- [ ] I have added tests if needed
+
+Optional checks:
+
+- [ ] My changes requires a change to the documentation
+- [ ] I have updated the documentation accordingly
+
+## Further comments
+
+*Optional* : Feel free to explain your motivation, share useful information or a feature screenshot.