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.

Sign up for GitHub

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

doc: make template more concise, add ref to CONTRIBUTING.md on template #357

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+34 −34
Open

doc: make template more concise, add ref to CONTRIBUTING.md on template #357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ assignees: ''
---

**Describe the bug**
<!-- A clear and concise description of what the bug is. -->
<!-- A clear and concise description of what the bug is -->

**To Reproduce**
<!-- Steps or code to reproduce the behavior. -->
**Steps to Reproduce**
<!-- Steps or code to reproduce the behavior -->

**Expected behavior**
<!-- A clear and concise description of what you expected to happen. -->
<!-- A clear and concise description of what you expected to happen -->

**Build environment**

Expand Down
49 changes: 24 additions & 25 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,36 @@
### What is this PR for?

This PR fixes issue <!-- insert the issue link or #<issue number> -->

### What is the purpose of this pull request?

- [ ] Bug fix;
- [ ] New feature;
- [ ] Docs update;
- [ ] Test;
- [ ] Bug fix
- [ ] Documentation update
- [ ] New feature
- [ ] Test
- [ ] Other: <!-- Please describe it -->

### Which crates are being modified?

- [ ] floresta-chain
- [ ] floresta-cli
- [ ] floresta-common
- [ ] floresta-compact-filters
- [ ] floresta-electrum
- [ ] floresta-watch-only
- [ ] floresta-wire
- [ ] floresta
- [ ] Other: <!-- Please describe it -->.

### Which aspect of floresta its being addresed?

- [ ] Blockchain;
- [ ] Nodes communication;
- [ ] User consumption;
- [ ] Utreexo accumulator;
- [ ] Other: <!-- Please describe it -->.

### Checklists

- [ ] I've signed all my commits;
- [ ] I ran `just lint`;
- [ ] I ran `cargo test`;
- [ ] I checked the integration tests;
- [ ] I'm linking the issue being fixed by this PR (if any).

### Description

<!-- Describe the purpose of this PR, what's being adding and/or fixed -->
<!-- Describe the purpose of this PR, what's being adding and/or fixed. If there is an open issue for it, link it here -->

### Notes to the reviewers

<!-- In this section you can include notes directed to the reviewers, like explaining why some parts of the PR were done in a specific way -->

### Checklist

- [ ] I've signed all my commits
- [ ] I ran `just lint`
- [ ] I ran `cargo test`
- [ ] I've checked the integration tests
- [ ] I've followed the [contribution guidelines](https://github.com/vinteumorg/Floresta/blob/master/CONTRIBUTING.md)
- [ ] I'm linking the issue being fixed by this PR (if any)
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,17 @@ messages follow the ["Conventional Commits 1.0.0"](https://www.conventionalcommi
Peer review
-----------

To make sure our code has the highest quality and is maintainable for the posterity, we have a thorough peer review process, where pull requests needs to be reviewed by at least one maintainer, and must not have any outstanding comment from regular contributors.
To make sure our code has the highest quality and is maintainable for posterity, we have a thorough peer review process, where pull requests need to be reviewed by at least one maintainer, and must not have any outstanding comment from regular contributors.

We welcome everyone to review and give their feedbacks on changes to Floresta. The conventions on how to communicate in a code review are based on[Bitcoin Core](https://github.com/bitcoin/bitcoin/blob/v23.0/CONTRIBUTING.md#peer-review)
We welcome everyone to review and give their feedback on changes to Floresta. The conventions on how to communicate in a code review are based on [Bitcoin Core](https://github.com/bitcoin/bitcoin/blob/v23.0/CONTRIBUTING.md#peer-review)

### Conceptual Review

A review can be a conceptual review, where the reviewer leaves a comment
A review can be a conceptual review, where the reviewer leaves a comment:

- Concept (N)ACK: "I do (not) agree with the general goal of this pull request",
- Approach (N)ACK: Concept (N)ACK, but "I do (not) agree with the approach of this change".

Concept (N)ACK, meaning "I do (not) agree with the general goal of this pull request",
Approach (N)ACK, meaning Concept ACK, but "I do (not) agree with the approach of this change".
A NACK needs to include a rationale why the change is not worthwhile. NACKs without accompanying reasoning may be disregarded.

### Code Review
Expand Down