Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Github templates #517

Merged
merged 2 commits into from
Jul 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@ labels: bug
assignees: ''
---

> [!WARNING]
> 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-rollups` channel.

> [!IMPORTANT]
> 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.

## 🙂 Expected behavior

What was expected?
Expand Down
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@ labels: feature
assignees: ''
---

> [!WARNING]
> 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-rollups` channel.

> [!IMPORTANT]
> 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 problem that you are trying to solve?
Expand Down
3 changes: 3 additions & 0 deletions .github/ISSUE_TEMPLATE/technical-debt.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ labels: refactor
assignees: ''
---

> [!WARNING]
> Please, read carefully before submitting an issue.

## 📚 Context

What is the problem that you are trying to solve?
Expand Down
3 changes: 3 additions & 0 deletions .github/ISSUE_TEMPLATE/update-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ labels: chore
assignees: ''
---

> [!WARNING]
> Please, read carefully before submitting an issue.

## 📈 Subtasks

- [ ] Cartesi
Expand Down
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
> [!WARNING]
> 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.

> [!IMPORTANT]
> Please make sure to check our [Contributing Guidelines](https://github.com/cartesi/rollups-node/blob/main/docs/contributing.md) and, most importantly, review our [Contributing License Agreement](https://forms.gle/k3E9ZNkZY6Vy3mkK9), sign and send it to [[email protected]](mailto:[email protected]) before we can proceed.

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.
Loading