Skip to content

Added issue/PR templates #349

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

Jump to bottom
Merged
merged 1 commit into from
Jan 24, 2025
Merged

Added issue/PR templates #349

merged 1 commit into from
Jan 24, 2025

Conversation

@qlrd
Copy link
Contributor

@qlrd qlrd commented Jan 23, 2025

What is this PR for?

This PR apply some idea from #348.

What is the purpose of this pull request?

  • Bug fix;
  • New feature;
  • Docs update;
  • Test;
  • Other: Templates for issues and PRs.

Checklists

  • I've signed all my commits;
  • I ran cargo fmt;
  • I ran cargo clippy
  • I ran cargo test;
  • I ran cargo build --release or bash tests/prepare.sh;
  • I ran poetry run poe tests;
  • I'm linking the issue being fixed by this PR.

Description

Various projects in bitcoin ecosystem uses some templates to help or format the ways the Issues/PRs are documented. With this in mind, it were:

  • added issue template for bug report (with description, environment context, steps to reproduce) and another template for enhancement requests.

  • Added a PR template with a brief description, an item selector for what was modified, as well as a checklist for the steps required before submitting the PR and a space for a description. As proof of concept, the submitted template is used in this PR.

Notes to the reviewers

These templates are a mix of templates used in Krux as well BDK.

@qlrd qlrd changed the title Added issue template for bug report (with description, environment Added issue/PR templates Jan 23, 2025
@luisschwab
Copy link
Contributor

BDK has a good template

@qlrd
Copy link
Contributor Author

qlrd commented Jan 23, 2025 •
edited
Loading

BDK has a good template

Awesome templates, btw. I added mainly the bug report and PR template from them.

But needed to edit since it has some BDK specifics items. I thought in some Floresta specifics but can't be able to think in all of them (or maybe some are not necessary, i don't know).

Thought in some templates for help wanted, documentation, dependencies issues to.

@Davidson-Souza
Copy link
Member

Strong Concept ACK

For the bug template, could you add an instruction to run florestad --help and copy the first line to the version and environment part? I shows everything that might be relevant. This also works for the pre-built binaries.

An example from one of my builds: version 0.7.0-32-g7c80df1 compiled for x86_64-linux-gnu with rustc 1.74.1 (a28077b28 2023-12-04)

jaoleal
jaoleal reviewed Jan 23, 2025
View reviewed changes
Copy link
Collaborator

@jaoleal jaoleal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice changes! Quality of Development is always a good thing to improve.

Here some suggestions:

@jaoleal
Copy link
Collaborator

jaoleal commented Jan 23, 2025

A good follow up PR for this would be referencing this templates and "how to"`s about it on CONTRIBUTING.md

@qlrd
Copy link
Contributor Author

qlrd commented Jan 23, 2025

A good follow up PR for this would be referencing this templates and "how to"`s about it on CONTRIBUTING.md

adding a item like this:

  • I followed the contribution guidelines;

And a file like this one, right?

Davidson-Souza
Davidson-Souza reviewed Jan 23, 2025
View reviewed changes
@Davidson-Souza
Copy link
Member

ACK 2571e08 modulo a super simple nit in #349 (comment)

@qlrd
Copy link
Contributor Author

qlrd commented Jan 23, 2025 •
edited
Loading

A good follow up PR for this would be referencing this templates and "how to"`s about it on CONTRIBUTING.md

adding a item like this:

* I followed the  contribution guidelines;

And a file like this one, right?

Thinking now... there isn't a CONTRIBUTING.md yet.

Maybe isn't better to address this (important file) to another PR (and when done, address this item)?

I mean, it will be fundamental that this guide isnt a just copy/paste file from bdk.

Or maybe, if a copy/paste is done, some particular elements (such as those @Davidson-Souza submitted on BDL) should be meticulously edited before a merge is done.

On the other hand, it would also be interesting to build this guide with the development partners, jointly, as an enhancement issue.

@qlrd
Added issue template for bug report with:
1e72672 
- Description;
- steps for reproduce
- expected behavior;
- build environment;
- additional context.

Added a PR template with:

- Purpose linked with a issue;
- Addresed aspect;
- Checklist of PR's tasks;
- Description;
- Notes to the reviewers.
@Davidson-Souza
Copy link
Member

A good follow up PR for this would be referencing this templates and "how to"`s about it on CONTRIBUTING.md

adding a item like this:

* I followed the  contribution guidelines;

And a file like this one, right?

Thinking now... there isn't a CONTRIBUTING.md yet.

Maybe isn't better to address this (important file) to another PR (and when done, address this item)?

I mean, it will be fundamental that this guide isnt a just copy/paste file from bdk.

Or maybe, if a copy/paste is done, some particular elements (such as those @Davidson-Souza submitted on BDL) should be meticulously edited before a merge is done.

On the other hand, it would also be interesting to build this guide with the development partners, jointly, as an enhancement issue.

I think this PR is fine as-is. We can refine it in the future anyway. We can also start working on a CONTRIBUTING.md. Would you want me to open a draft pr with the points I've mentioned yesterday?

reACK 1e72672

@qlrd
Copy link
Contributor Author

qlrd commented Jan 24, 2025

A good follow up PR for this would be referencing this templates and "how to"`s about it on CONTRIBUTING.md

adding a item like this:

* I followed the  contribution guidelines;

And a file like this one, right?

Thinking now... there isn't a CONTRIBUTING.md yet.
Maybe isn't better to address this (important file) to another PR (and when done, address this item)?
I mean, it will be fundamental that this guide isnt a just copy/paste file from bdk.
Or maybe, if a copy/paste is done, some particular elements (such as those @Davidson-Souza submitted on BDL) should be meticulously edited before a merge is done.
On the other hand, it would also be interesting to build this guide with the development partners, jointly, as an enhancement issue.

I think this PR is fine as-is. We can refine it in the future anyway. We can also start working on a CONTRIBUTING.md. Would you want me to open a draft pr with the points I've mentioned yesterday?

reACK 1e72672

Awesome, Ok!

@jaoleal
Copy link
Collaborator

jaoleal commented Jan 24, 2025 •
edited
Loading

Maybe isn't better to address this (important file) to another PR (and when done, address this item)?

Yes... a follow up PR is another PR made to complement another one but, still... separated.

@jaoleal
Copy link
Collaborator

jaoleal commented Jan 24, 2025

LGTM

@Davidson-Souza Davidson-Souza merged commit 7304b4f into vinteumorg:master Jan 24, 2025
6 checks passed
@qlrd qlrd mentioned this pull request Jan 24, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Davidson-Souza Davidson-Souza Davidson-Souza left review comments

+1 more reviewer

@jaoleal jaoleal jaoleal left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@qlrd @luisschwab @Davidson-Souza @jaoleal