-
Notifications
You must be signed in to change notification settings - Fork 97
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(templates): add various GH templates.
- add issue templates for bug reports, feature requests, and questions - add pull request template in Markdown format. - add a guide for contributors and code of conduct - update Makefile with generic `help` target
- Loading branch information
1 parent
2cafa3b
commit 023514f
Showing
9 changed files
with
447 additions
and
6 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
name: Bug report | ||
description: Create a report to help us improve | ||
title: "" | ||
labels: [bug] | ||
assignees: "" | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: "Thanks for taking the time to fill out this bug report!" | ||
- type: textarea | ||
id: describe-bug | ||
attributes: | ||
label: Describe the bug | ||
description: A clear and concise description of what the bug is. | ||
placeholder: "Tell us what happens instead of the expected behavior..." | ||
render: markdown | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: reproduce-steps | ||
attributes: | ||
label: Steps to reproduce the behavior | ||
description: "Please share the steps to reproduce the issue:" | ||
placeholder: | | ||
1. Go to '...' | ||
2. Click on '...' | ||
3. Scroll down to '...' | ||
4. See error | ||
render: markdown | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: expected-behavior | ||
attributes: | ||
label: Expected behavior | ||
description: A clear and concise description of what you expected to happen. | ||
placeholder: "Explain what you expected to happen..." | ||
render: markdown | ||
validations: | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: "You can add screenshots or additional context below." | ||
- type: file | ||
id: screenshots | ||
attributes: | ||
label: Screenshots | ||
description: If applicable, add screenshots to help explain your problem. | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional context | ||
description: Add any other context about the problem here. | ||
placeholder: "Any other information or context..." | ||
render: markdown | ||
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,46 @@ | ||
name: Feature request | ||
description: Suggest an idea for this project | ||
title: "" | ||
labels: [] | ||
assignees: "" | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: "Thanks for suggesting a feature! Please fill out the form below." | ||
- type: textarea | ||
id: problem-description | ||
attributes: | ||
label: Is your feature request related to a problem? Please describe. | ||
description: A clear and concise description of what the problem is. For example: "I'm always frustrated when..." | ||
placeholder: "Describe the problem or the frustration..." | ||
render: markdown | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: desired-solution | ||
attributes: | ||
label: Describe the solution you'd like | ||
description: A clear and concise description of what you want to happen. | ||
placeholder: "Explain your ideal solution..." | ||
render: markdown | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: alternatives-considered | ||
attributes: | ||
label: Describe alternatives you've considered | ||
description: A clear and concise description of any alternative solutions or features you've considered. | ||
placeholder: "List any alternative solutions or features..." | ||
render: markdown | ||
validations: | ||
required: false | ||
- type: markdown | ||
attributes: | ||
value: "If you have any additional context or screenshots, you can add them below." | ||
- type: file | ||
id: additional-context | ||
attributes: | ||
label: Additional context or screenshots | ||
description: Add any other context or screenshots about the feature request here. | ||
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,27 @@ | ||
name: Question | ||
description: Post a question about the project | ||
title: "" | ||
labels: [question] | ||
assignees: "" | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: "Have a question about the project? Feel free to ask it here!" | ||
- type: textarea | ||
id: your-question | ||
attributes: | ||
label: Your Question | ||
description: A clear and concise question. | ||
placeholder: "What would you like to ask?" | ||
render: markdown | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional Context | ||
description: Add any other context about your question here. | ||
placeholder: "Provide additional information or context if necessary..." | ||
render: markdown | ||
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,25 @@ | ||
--- | ||
name: Pull Request | ||
about: A pull request | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
--- | ||
|
||
[pull_requests]: https://github.com/controlplaneio/simulator/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc | ||
|
||
<!-- You can erase any parts of this template not applicable to your Pull Request. --> | ||
|
||
**All Submissions.** | ||
|
||
- [ ] Have you followed the guidelines in our [Contributing document](../../CONTRIBUTING.md)? | ||
- [ ] Have you checked to ensure there aren't other open [Pull Requests][pull_requests] for the same update/change? | ||
|
||
**Code Submissions.** | ||
|
||
- [ ] Does your submission pass linting, tests, and security analysis? | ||
|
||
**Changes to Core Features.** | ||
|
||
- [ ] Have you added an explanation of what your changes do and why you'd like us to include them? | ||
- [ ] Have you written new tests for your core changes, as applicable? |
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,72 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, 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 behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
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, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior | ||
may be reported by contacting Andrew Martin andy(at)control-plane.io. | ||
All complaints will be reviewed and investigated and will result in a response that is deemed | ||
necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of | ||
an incident. Further details of specific enforcement policies may be | ||
posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html |
Oops, something went wrong.