-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Pull-Requests and Issues templates
- Loading branch information
Showing
5 changed files
with
187 additions
and
0 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,62 @@ | ||
--- | ||
name: Bug Report | ||
about: Template for reporting bugs | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
| WARNING: Please, read carefully before submitting an issue | | ||
|------------------------------------------------------------| | ||
|
||
Do not use issues to seek technical support. | ||
If you need support read the [documentation](https://docs.cartesi.io/) first. | ||
If you still have unanswered questions or need further discussion, join the [Cartesi Discord server](https://discord.gg/cartesi) and use the `#cartesi-machine` channel. | ||
|
||
Before submitting a new issue, please make sure that: | ||
- You are sure the issue manifests itself on the latest release (i.e., in the main branch); | ||
- You have verified that a similar issue has not already been reported; | ||
- You have verified, with your best effort, that your code or use case is not itself at fault. | ||
|
||
## Context | ||
|
||
What is the bug that you are experiencing? | ||
Why is this bug relevant? | ||
|
||
(Please try to be clear and concise.) | ||
|
||
## Expected behavior | ||
|
||
What was expected? | ||
|
||
## Actual behavior | ||
|
||
What happened instead? | ||
|
||
## Steps to reproduce | ||
|
||
Please describe a minimal set of steps to reproduce the bug. | ||
Try to keep it as simple as possible, focusing exclusively on the bug. | ||
Your description should include the artifacts used and their versions. | ||
Provide the exact commands needed to reproduce the bug, if possible in the form of a script that can be run on other machines. | ||
|
||
## Environment | ||
|
||
Please describe the environment where the bug happens. | ||
|
||
Include the following (when applicable and/or relevant): | ||
- Emulator version; | ||
- Host operating system (e.g. Ubuntu 22.04, MacOS 13, Cartesi Playground v0.6.0); | ||
- Host architecture (e.g. x86\_64, arm64); | ||
- Docker version (e.g. Docker Desktop 4.19.0); | ||
- Compiler version (e.g. GCC 12.3, Clang 15.0.7). | ||
|
||
## Possible solutions | ||
|
||
*This section is optional.* | ||
|
||
Is there any workaround for the issue? (This may help others experiencing the same issue.) | ||
|
||
Can you offer any hint on how to solve the issue? | ||
What parts of the code will be affected? |
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 | ||
about: Template for requesting new features | ||
title: '' | ||
labels: feature | ||
assignees: '' | ||
|
||
--- | ||
|
||
| WARNING: Please, read carefully before submitting an issue | | ||
|------------------------------------------------------------| | ||
|
||
Do not use issues to seek technical support. | ||
If you need support read the [documentation](https://docs.cartesi.io/) first. | ||
If you still have unanswered questions or need further discussion, join the [Cartesi Discord server](https://discord.gg/cartesi) and use the `#cartesi-machine` channel. | ||
|
||
Before submitting a new issue, please make sure that: | ||
- You are sure the issue manifests itself on the latest release (i.e., in the main branch); | ||
- You have verified that a similar issue has not already been reported; | ||
- You have verified, with your best effort, that your code or use case is not itself at fault. | ||
|
||
## Context | ||
|
||
What problem are you trying to solve? | ||
Why is this feature relevant? | ||
|
||
(Please try to be clear and concise.) | ||
|
||
## Possible solutions | ||
|
||
*This section is optional.* | ||
|
||
What are the possible solutions? | ||
If there are multiple alternatives, what are the benefits and drawbacks of each one? | ||
|
||
## Subtasks | ||
|
||
*This section is optional.* | ||
|
||
- [ ] If there is a solution, what are the subtasks for completing this issue? | ||
|
||
## Definition of Done | ||
|
||
*This section is optional.* | ||
|
||
- [ ] If there is a solution, what are the final deliverables? |
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,36 @@ | ||
--- | ||
name: Technical Debt | ||
about: Template for proposing solutions to technical debts | ||
title: '' | ||
labels: refactor | ||
assignees: '' | ||
|
||
--- | ||
|
||
| WARNING: Please, read carefully before submitting an issue | | ||
|------------------------------------------------------------| | ||
|
||
## Context | ||
|
||
What problem are you trying to solve? | ||
Why is this problem relevant? | ||
How does this problem affect the feature roadmap? | ||
Is it a blocker to implement a new future? | ||
What parts of the architecture and code are affected? | ||
|
||
## Possible solutions | ||
|
||
What are the possible solutions? | ||
If there are multiple alternatives, what are the benefits and drawbacks of each one? | ||
|
||
## Subtasks | ||
|
||
*This section is optional.* | ||
|
||
- [ ] What are the subtasks for completing this issue? | ||
|
||
## Definition of Done | ||
|
||
*This section is optional.* | ||
|
||
- [ ] What are the final deliverables? |
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,21 @@ | ||
--- | ||
name: Update Dependencies | ||
about: Template for updating dependencies | ||
title: '' | ||
labels: chore | ||
assignees: '' | ||
|
||
--- | ||
|
||
| WARNING: Please, read carefully before submitting an issue | | ||
|------------------------------------------------------------| | ||
|
||
## Context | ||
|
||
Does the dependency have a bug fix? | ||
Does it provide additional features or optimizations? | ||
|
||
## Subtasks | ||
|
||
- [ ] Verify that the new version is available on all supported platforms. | ||
- [ ] Update build scripts and Dockerfiles |
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,22 @@ | ||
| WARNING: Please, read carefully before submitting a pull request | | ||
|------------------------------------------------------------------| | ||
|
||
Although this software is open source and we welcome contributions, | ||
we believe these contributions should be preceded by an open discussion. | ||
Open discussions tend to result in better solutions to any given problem, | ||
and help maintain and improve the quality of the software. | ||
If you would like to see a bug fixed or a new feature implemented, | ||
please open an issue for the discussion rather than directly opening | ||
a pull request. | ||
|
||
If you would like to contribute please read [CONTRIBUTING.md](../blob/main/CONTRIBUTING.md). | ||
|
||
When you finally create a pull request, please follow these guidelines: | ||
|
||
- Make sure the description clearly describes the problem, its solution, and references the associated issue; | ||
- Do not create large pull requests (involving many different changes) because these are difficult to review. Instead, break large changes into smaller ones and create independent pull requests for each one; | ||
- Use different pull requests for different issues. Each pull request should address a single issue; | ||
- When fixing a bug or adding a new feature, make sure to add tests that cover your changes. This will ensure the changes will continue to work in the future; | ||
- Verify that changes do not break the tests. You can check this with `make test`; | ||
- Follow the same coding style rules as the rest of the code base; | ||
- Pull requests for stylistic changes (or even simple typos or grammatical errors) may be rejected. Pull requests should always address worthy issues. |