Change the readme file, and add some templates for issue tracking and pull requests

This commit is contained in:
Godzil
2018-06-18 21:57:51 +01:00
parent fb14020a7f
commit c2e9449630
4 changed files with 59 additions and 52 deletions

0
.github/CONTRIBUTING.md vendored Normal file
View File

View File

@@ -7,29 +7,25 @@ about: Create a report to help us improve
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Please fill theses informations:**
(Add a X between brackets to make them ticked)
- OS: [e.g:. Windows 10, Mac OS X 10.13, ...]
- [ ] I'm using the latest version of Crunchy
- Serie you get a problem with (and specify which episode if it is specific to one):
- The command line you are running Crunchy with:
- The message Crunchy is giving you, if any:
**Please be careful to remove your real account login and password if they appear!**
**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 context**
Add any other context about the problem here.
_Also don't hesitate to add labels you feel apropriate on your report._

11
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,11 @@
*Goal for this pull request*
A clear and concise description of pull request
### Checklist
[ ] I've run `npm run compile` and it produce no error
[ ] I've run `npm run test` and it produce no error
[ ] I've not pushing more than one feature in that pull request
[ ] My branch is updated with the latest from main when I make that pull request
[ ] I've tested as much as I can my changes