-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add contributing.md and issue templates
fixes #269
- Loading branch information
Showing
10 changed files
with
825 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
name: '🐛 Bug Report' | ||
description: Create a new ticket for a bug. | ||
labels: ['bug'] | ||
assignees: ['anguspiv'] | ||
title: '🐛 [BUG] - <title>' | ||
body: | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: 'Description' | ||
description: Please enter an explicit description of your issue | ||
placeholder: Short and explicit description of your incident... | ||
validations: | ||
required: true | ||
- type: input | ||
id: reprod-url | ||
attributes: | ||
label: 'Reproduction URL' | ||
description: Please enter your GitHub URL to provide a reproduction of the issue | ||
placeholder: ex. https://www.angusp.com | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: reprod | ||
attributes: | ||
label: 'Reproduction steps' | ||
description: Please enter an explicit description of your issue | ||
value: | | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
render: bash | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: screenshot | ||
attributes: | ||
label: 'Screenshots' | ||
description: If applicable, add screenshots to help explain your problem. | ||
value: | | ||
![DESCRIPTION](LINK.png) | ||
render: bash | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: 'Logs' | ||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
render: bash | ||
validations: | ||
required: false | ||
- type: dropdown | ||
id: browsers | ||
attributes: | ||
label: 'Browsers' | ||
description: What browsers are you seeing the problem on ? | ||
multiple: true | ||
options: | ||
- Firefox | ||
- Chrome | ||
- Safari | ||
- Microsoft Edge | ||
- Opera | ||
validations: | ||
required: false | ||
- type: dropdown | ||
id: os | ||
attributes: | ||
label: 'OS' | ||
description: What is the impacted environment ? | ||
multiple: true | ||
options: | ||
- iPhone iOS | ||
- iPad iOS | ||
- Android | ||
- Windows | ||
- Linux | ||
- Mac | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
name: '💡 Feature Request' | ||
description: Create a new ticket for a new feature request | ||
title: '💡 [REQUEST] - <title>' | ||
labels: ['question'] | ||
body: | ||
- type: textarea | ||
id: summary | ||
attributes: | ||
label: 'Summary' | ||
description: Provide a brief explanation of the feature | ||
placeholder: Describe in a few lines your feature request | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: basic_example | ||
attributes: | ||
label: 'Basic Example' | ||
description: Indicate here some basic examples of your feature. | ||
placeholder: A few specific words about your feature request. | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: drawbacks | ||
attributes: | ||
label: 'Drawbacks' | ||
description: What are the drawbacks/impacts of your feature request ? | ||
placeholder: Identify the drawbacks and impacts while being neutral on your feature request | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: unresolved_question | ||
attributes: | ||
label: 'Unresolved questions' | ||
description: What questions still remain unresolved ? | ||
placeholder: Identify any unresolved issues. | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: screenshot | ||
attributes: | ||
label: 'Screenshots' | ||
description: If applicable, add screenshots or images to help explain your feature. | ||
value: | | ||
![DESCRIPTION](LINK.png) | ||
render: bash | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: { % data variables.product.prodname_gcf % } | ||
url: https://github.com/orgs/community/discussions | ||
about: Please ask and answer questions here. | ||
- name: '✉️ Contact' | ||
url: mailto:[email protected] | ||
about: Please contact me directly. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
name: '🍻 Pull Request' | ||
description: Create a new pull request. | ||
assignees: ['anguspiv'] | ||
title: '🍻 [PR] - <title>' | ||
body: | ||
- type: select | ||
id: type | ||
attributes: | ||
label: 'Type' | ||
description: What type of change does this PR introduce ? | ||
options: | ||
- '🐛 Bug fix' | ||
- '💡 Feature' | ||
- '🔨 Refactor' | ||
- '📚 Documentation' | ||
- '🔧 Configuration' | ||
- '🚀 Performance' | ||
- '🔖 Release' | ||
- '🚧 WIP' | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: 'Description' | ||
description: Please enter an explicit description of your issue | ||
placeholder: Short and explicit description of your incident... | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: screenshots | ||
attributes: | ||
label: 'Screenshots' | ||
description: If applicable, add screenshots or recordings to help explain your changes. | ||
value: | | ||
![DESCRIPTION](LINK.png) | ||
render: bash | ||
validations: | ||
required: false | ||
- type: checkboxes | ||
id: checklist | ||
attributes: | ||
label: 'Checklist' | ||
description: Have you completed all of the following ? | ||
options: | ||
- 'Written appropriate tests' | ||
- 'Updated the documentation' | ||
- 'Followed the coding style' | ||
- 'Followed the commit message guidelines' | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"printWidth": 100, | ||
"printWidth": 80, | ||
"singleQuote": true, | ||
"trailingComma": "all", | ||
"arrowParens": "always" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
# Code of Conduct - [www.angusp.com](https://www.angusp.com) | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to make participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, nationality, personal | ||
appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behaviour that contributes to a positive environment for our | ||
community include: | ||
|
||
- Demonstrating empathy and kindness toward other people | ||
- Being respectful of differing opinions, viewpoints, and experiences | ||
- Giving and gracefully accepting constructive feedback | ||
- Accepting responsibility and apologising to those affected by our mistakes, | ||
and learning from the experience | ||
- Focusing on what is best not just for us as individuals, but for the | ||
overall community | ||
|
||
Examples of unacceptable behaviour include: | ||
|
||
- The use of sexualised language or imagery, and sexual attention or advances | ||
- Trolling, insulting or derogatory comments, and personal or political attacks | ||
- Public or private harassment | ||
- Publishing others' private information, such as a physical or email | ||
address, without their explicit permission | ||
- Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying and enforcing our standards of | ||
acceptable behaviour and will take appropriate and fair corrective action in | ||
response to any behaviour that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject | ||
comments, commits, code, wiki edits, issues, and other contributions that are | ||
not aligned to this Code of Conduct, and will | ||
communicate reasons for moderation decisions when appropriate. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when | ||
an individual is officially representing the community in public spaces. | ||
Examples of representing our community include using an official e-mail address, | ||
posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behaviour may be | ||
reported to the community leaders responsible for enforcement at <[email protected]>. | ||
All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the | ||
reporter of any incident. | ||
|
||
## Enforcement Guidelines | ||
|
||
Community leaders will follow these Community Impact Guidelines in determining | ||
the consequences for any action they deem in violation of this Code of Conduct: | ||
|
||
### 1. Correction | ||
|
||
**Community Impact**: Use of inappropriate language or other behaviour deemed | ||
unprofessional or unwelcome in the community. | ||
|
||
**Consequence**: A private, written warning from community leaders, providing | ||
clarity around the nature of the violation and an explanation of why the | ||
behaviour was inappropriate. A public apology may be requested. | ||
|
||
### 2. Warning | ||
|
||
**Community Impact**: A violation through a single incident or series | ||
of actions. | ||
|
||
**Consequence**: A warning with consequences for continued behaviour. No | ||
interaction with the people involved, including unsolicited interaction with | ||
those enforcing the Code of Conduct, for a specified period of time. This | ||
includes avoiding interactions in community spaces as well as external channels | ||
like social media. Violating these terms may lead to a temporary or | ||
permanent ban. | ||
|
||
### 3. Temporary Ban | ||
|
||
**Community Impact**: A serious violation of community standards, including | ||
sustained inappropriate behaviour. | ||
|
||
**Consequence**: A temporary ban from any sort of interaction or public | ||
communication with the community for a specified period of time. No public or | ||
private interaction with the people involved, including unsolicited interaction | ||
with those enforcing the Code of Conduct, is allowed during this period. | ||
Violating these terms may lead to a permanent ban. | ||
|
||
### 4. Permanent Ban | ||
|
||
**Community Impact**: Demonstrating a pattern of violation of community | ||
standards, including sustained inappropriate behaviour, harassment of an | ||
individual, or aggression toward or disparagement of classes of individuals. | ||
|
||
**Consequence**: A permanent ban from any sort of public interaction within | ||
the community. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version | ||
[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and | ||
[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md), | ||
and was generated by [contributing.md](https://contributing.md/generator). |
Oops, something went wrong.