Skip to content

Commit

Permalink
Update our CONTRIBUTING templates (#902)
Browse files Browse the repository at this point in the history
* [chore] update our contributing templates

* [fix] ask for the admin console version on the comment
  • Loading branch information
Leodau authored Feb 5, 2021
1 parent d9364a7 commit f490bcb
Show file tree
Hide file tree
Showing 4 changed files with 71 additions and 28 deletions.
25 changes: 18 additions & 7 deletions .github/issue_template.md → .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,19 @@
<!--- If you have a question about Kuzzle usage, please use Stackoverflow instead >
<!--- Post here and we will respond https://stackoverflow.com/questions/ask >
<!--- Github issues are limited to bugs and features requests >
---
name: "\U0001F41B Bug Report"
about: Create a bug report to help us improve
title: ''
labels: bug
assignees: ''
---

<!--
IMPORTANT - Github issues are limited to bugs and feature requests, >
If you have any questions on how to use Kuzzle or the Admin Console >
Please use the following resources instead: >
- Look for / ask questions on https://stackoverflow.com/questions/ask?tags=kuzzle >
- Refer to our docs at https://docs.kuzzle.io >
- Join us on Discord (We are active!) >
-->

<!--- Provide a general summary of the issue in the Title above -->

Expand All @@ -12,7 +24,7 @@
<!--- Tell us what happens instead of the expected behavior -->

## Possible Solution
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
<!--- Not mandatory, but suggest a fix/reason for the bug -->

## Steps to Reproduce
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
Expand All @@ -22,12 +34,11 @@
1.
2.
3.
4.

## Context (Environment)
<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
<!--- Include NodeJS version, SDK version, Kuzzle version, ElasticSearch version, ... -->
<!--- Include NodeJS version, Kuzzle version, Admin Console version, ... -->
Kuzzle version:
Node.js version:
Admin Console Version:
Admin Console version:
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: 🗣 Ask a Question
url: https://stackoverflow.com/questions/ask?tags=kuzzle
about: How does X work?
- name: 👋 Join us on Discord
url: http://join.discord.kuzzle.io/
about: I have an idea...
- name: 📖 Read Kuzzle's Documentation
url: https://docs.kuzzle.io
about: How to use Kuzzle?
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: "\U0001F680 Feature Request"
about: Suggest a new feature
title: ''
labels: feature-request
assignees: ''
---

<!--
IMPORTANT - Please ensure that your proposal has not already been submitted
You can check the following links:
- Github issues: https://github.com/kuzzleio/kuzzle-admin-console/issues?q=is%3Aissue+label%3Afeature-request
- Kuzzle's Public roadmap: https://trello.com/b/za9vOgRh/kuzzle-public-roadmap
-->

## Feature description

<!--- Describe the functionality as you would need it -->

## Example usecase

<!--- Give a concrete case example or this feature would help you develop a better application or solve a problem -->

## Possible solution (optional)

<!--- Give an example of how you would like to use the feature -->
<!--- You can put a sample Kuzzle query, sample code, etc. -->
36 changes: 15 additions & 21 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,41 @@
<!--
This template is not mandatory.
It simply serves to provide a guide to allow a better review of pull requests.
-->

<!--
IMPORTANT
Don't forget to add the corresponding "changelog:xxx" label to your PR.
This is part of our release process in order to generate the change log.
Thank you for submitting a Pull Request. Please:
- Read our CONTRIBUTING guidelines.
https://github.com/kuzzleio/kuzzle-admin-console/blob/master/CONTRIBUTING.md
- Associate an issue with the Pull Request.
- IMPORTANT - Add the corresponding "changelog:xxx" label to your PR.
-->

<!--- This template is optional. -->

## What does this PR do ?
<!-- Please fulfill this section -->

<!--
Please include a summary of the change and which issue is fixed.
Please also include relevant motivation and context.
List any dependencies that are required for this change.
Please include a summary of the change, relevant motivation and context.
Also, list any dependencies that are required for this change.
-->

### How should this be manually tested?

<!--
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
Please also list any relevant details for your test configuration
Please describe your test configuration, the tests ran to verify your changes
And give us instructions on how to reproduce them.
-->
- Step 1 :
- Step 2 :
- Step 3 :
...
- Step 3 :

### Other changes

<!--
Please describe here all changes not directly linked to the main issue, but made because of it.
For instance: issues spotted during this PR and fixed on-the-fly, dependencies update, and so on
Please outline any changes not directly linked to the main issue, but made because of it.
For instance: on-the-fly fixes, dependencies updates and so on.
-->

### Boyscout

### Screenshots (if appropriate)

<!--
Describe here minor improvements in the code base and not directly linked to the main changes:
typos fixes, better/new comments, small code simplification, new debug messages, and so on.
Finally, describe any improvements in the code base like:
Typo fixes, improved/new comments, debug messages and so on.
-->

0 comments on commit f490bcb

Please sign in to comment.