1
0
mirror of https://github.com/tcgdex/cards-database.git synced 2025-06-14 16:39:18 +00:00

docs: Update Code of Conduction, Contributing and templates (#145)

* feat: Add Code of Conduct

this Code of Conduct will be Enforced on the TCGdex's Github and on the TCGdex's Discord

* Update Issue templates

Signed-off-by: Avior <github@avior.me>

* Updated Documents

Signed-off-by: Avior <github@avior.me>
This commit is contained in:
2021-11-08 17:10:19 +01:00
committed by GitHub
parent d65a69bcac
commit 4dedacee58
12 changed files with 454 additions and 94 deletions

36
.github/ISSUE_TEMPLATE/api-issue.yml vendored Normal file
View File

@ -0,0 +1,36 @@
name: API Issue Report
description: Use this when you found an issue involving the TCGdex Server
title: "issue:"
labels: [issue, server]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to help advance the project witg your issue report!
- type: checkboxes
id: issue-location
validations:
required: true
attributes:
label: Where are you having the issue
options:
- label: GraphQL
- label: JSON API
- type: checkboxes
id: issue-item
attributes:
label: Is the issue affecting one of the two elements below ?
options:
- label: Translations
- label: Definitions Files (Open API, GraphQL Schema, etc)
- type: textarea
id: description
attributes:
label: Description
description: What is happening
validations:
required: true

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: TCGdex Discord
url: https://discord.gg/NehYTAhsZE
about: You can post user code related issues here.

View File

@ -0,0 +1,41 @@
name: Database Issue Report
description: Use this when you found an issue involving the TCGdex Datas
title: "issue:"
labels: [issue, database]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to help advance the project witg your issue report!
Note: if the issue is affecting translations or definitions files the correct issue report as the API one
- type: dropdown
id: data-type
validations:
required: true
attributes:
label: What seems to be the issue
description: Select the types of data that seems to be causing issues
options:
- label: Card
- label: Set
- label: Serie
- label: Other
- type: input
id: fields
attributes:
label: Field(s)
description: Tell which field(s) have the issue
placeholder: "ex: the Regulation Mark field"
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: Describe Your problem
placeholder: "ex: The cards have an incorrect name"
validations:
required: true

View File

@ -1,7 +1,7 @@
name: Enhancement
description: You have an Idea that will enhance the API, Use this issue Template!
title: "[Up]: "
labels: [project/database, project/server, project/compiler, type/enhancement]
description: Use this template if you have an Idea that will enhance the API/Database
title: "enhancement: "
labels: [enhancement]
body:
- type: markdown
attributes:
@ -25,6 +25,6 @@ body:
attributes:
label: Please explain in more details what idea you have
description: If you selected Other or new Data Type please put it as the first line
placeholder: "Ex: I would love to see the cards have this new field..."
placeholder: "Ex: I would love to see the cards have this new awesome field..."
validations:
required: true

View File

@ -1,26 +0,0 @@
name: Incorect Data
description: Use this when you found an incorrect information on a card/set/serie
title: "[Data]: "
labels: [project/database, type/incorrect-data]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to help correct incorrect informations about the database!
It should take less than a day to get an answer!
- type: textarea
id: incorrect
attributes:
label: Path of the incorrect file(s)
description: Fill the different files that have incorrect informations (one per line) (you can use * if it concern a lot of files)
placeholder: "ex: data/Sword & Shield/Sword & Shield/1.ts"
validations:
required: true
- type: textarea
id: description
attributes:
label: Incorrect informations
description: Describe the incorrect informations
placeholder: "ex: The cards have an incorrect name"
validations:
required: true

View File

@ -1,7 +1,7 @@
name: New Set
description: Use this Issue Template when you found a New set!
title: "[Set]: {Set Name}"
labels: [type/new-set, project/database]
description: Issue Template used when a new set has been announced by TPC
title: "new set: {Set Name}"
labels: [database]
body:
- type: markdown
attributes:
@ -11,7 +11,7 @@ body:
id: source
attributes:
label: Source
description: Where did you find out about this new set
description: Where did you find out about this new set (domain name MUST be pokemon.com)
placeholder: "ex: https://www.pokemon.com/us/pokemon-tcg/sword-shield-evolving-skies/explore-and-watch/"
validations:
required: true

View File

@ -1,7 +1,5 @@
<!--
Thanks for your Pull Request !
Please provide the related Issue using "Fix #0" or describe the change(s) you made
The issue title must follow Conventional Commit (verified by Github Actions) conventionalcommits.org
Thanks for your Pull Request, Please provide the related Issue using "Fix #0" or describe the change(s) you made.
The issue title must follow Conventional Commit (verified by Github Actions) conventionalcommits.org.
More informations at https://github.com/tcgdex/cards-database/blob/master/CONTRIBUTING.md
-->

View File

@ -5,13 +5,18 @@
version: 2
updates:
- package-ecosystem: "npm" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "daily"
- package-ecosystem: "github-actions"
# Workflow files stored in the
# default location of `.github/workflows`
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "daily"
- package-ecosystem: "npm"
directory: "/server"
schedule:
interval: "daily"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"