From 82991c8deddd55065beb216d8184b7d45bbc9d71 Mon Sep 17 00:00:00 2001 From: Micah Maphet Date: Fri, 19 Dec 2025 13:18:03 -0500 Subject: [PATCH 1/5] added PR_REQUEST_TEMPLATE.md --- .github/PR_REQUEST_TEMPLATE.md | 104 +++++++++++++++++++++++++++++++++ 1 file changed, 104 insertions(+) create mode 100644 .github/PR_REQUEST_TEMPLATE.md diff --git a/.github/PR_REQUEST_TEMPLATE.md b/.github/PR_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..ad170d583e --- /dev/null +++ b/.github/PR_REQUEST_TEMPLATE.md @@ -0,0 +1,104 @@ +# PR Request Template + +Thank you for contributing to BitPay Bitcore! + +Please fill out the sections below to help us review your pull request efficiently. + +## Summary + +- What does this PR do? +- Why is it needed? + +### Title Conventions + +Prefix the PR title with a component tag for clarity, following patterns seen in recent work (e.g., kajoseph’s PRs): +- Examples: [BWS], [BCN], [CLI], [CWC], [BCC], [Libs], [BWC] +- For broad repo-wide changes, use [*] or a suitable umbrella tag. + +### Component(s) + +Select one or more affected components: +- [ ] BWS (Bitcore Wallet Service) +- [ ] BCN (Bitcore Node) +- [ ] CLI (bitcore-cli) +- [ ] CWC (Crypto Wallet Core) +- [ ] BCC (bitcore-client) +- [ ] Libs (bitcore-libs) +- [ ] BWC (bitcore-wallet-client) +- [ ] Other: __________ + +## Type of Change + +- [ ] Bug fix +- [ ] New feature +- [ ] Refactor +- [ ] Performance improvement +- [ ] Test-related (tests/coverage) +- [ ] Docs update +- [ ] Build/CI +- [ ] Chore/Maintenance + +## Changes + +- List the key changes introduced by this PR. + +## Breaking Changes + +- [ ] No breaking changes +- [ ] Breaking changes (describe below) + +If breaking, explain the impact and migration path: +- Impact: +- Migration steps: + +## Testing + +- [ ] Unit tests added/updated +- [ ] Integration tests added/updated +- [ ] Manual testing performed + +Describe the testing strategy and results: +- Steps to reproduce/verify: +- Environments tested: +- Relevant test cases: + +## Screenshots or Logs (if applicable) + +- Include any relevant output, screenshots, or logs. + +## Security Considerations + +- [ ] No security-related changes +- [ ] Security-related changes (describe below) + +If security-related, explain risk and mitigation: +- Risk: +- Mitigation: +- Additional notes: + +## Documentation + +- [ ] README/Docs updated +- [ ] Not required + +Links or notes for doc updates: +- Docs PR/Section: +- User-facing changes documented: + +## Checklist + +- [ ] Title follows component tag convention (e.g., [BWS], [BCN], [CLI], [CWC], [BCC], [Libs], [BWC], [*]) +- [ ] Linked to an existing issue/discussion (e.g., closes #123) +- [ ] Code follows project style and lint rules +- [ ] Commit messages follow Conventional Commits +- [ ] All tests pass locally (`npm test` or applicable commands) +- [ ] CI checks pass (when applicable) +- [ ] Includes necessary configuration updates (if any) +- [ ] No sensitive information committed +- [ ] Reviewed performance implications (if relevant) +- [ ] Verified cross-platform compatibility (Linux/macOS/Windows if applicable) + +## Additional Notes + +- Anything reviewers should pay extra attention to? +- Dependencies or follow-ups required? \ No newline at end of file From 48288de6c6230499405d34d3ceeb936005f41bc1 Mon Sep 17 00:00:00 2001 From: Micah Maphet Date: Fri, 19 Dec 2025 13:20:43 -0500 Subject: [PATCH 2/5] added ISSUE_TEMPLATE.md --- .github/ISSUE_TEMPLATE.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..86d903bee7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,38 @@ +# Issue Template + +Use this template to report a bug or request a feature. Keep it concise and actionable. + +## Type +- [ ] Bug +- [ ] Feature Request + +## Summary +A brief description of the problem or the requested capability. + +## Details +- For bugs: what’s broken and where? +- For features: what should be added or improved? + +## Steps to Reproduce (bugs) +1. … +2. … +3. … + +## Expected vs Actual (bugs) +- Expected: +- Actual: + +## Environment (bugs) +- Bitcore version: +- Node.js version: +- OS: +- Any relevant config: + +## Screenshots/Logs (optional) +Attach images or paste logs that help illustrate the issue. + +## Proposed Solution (optional) +If you have an idea for how to fix or implement this, describe it here. + +## Additional Context (optional) +Links, related issues, or other info. \ No newline at end of file From cefd0b003d615c9cc6c5969f8af2cc0c4da2530a Mon Sep 17 00:00:00 2001 From: Micah Maphet Date: Mon, 5 Jan 2026 11:52:46 -0500 Subject: [PATCH 3/5] simplified PR template, replaced issue template with bug and feature templates --- .github/ISSUE_TEMPLATE.md | 38 -------- .github/ISSUE_TEMPLATE/bug_report.md | 37 ++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 13 +++ .github/PR_REQUEST_TEMPLATE.md | 108 ++-------------------- 4 files changed, 59 insertions(+), 137 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 86d903bee7..0000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,38 +0,0 @@ -# Issue Template - -Use this template to report a bug or request a feature. Keep it concise and actionable. - -## Type -- [ ] Bug -- [ ] Feature Request - -## Summary -A brief description of the problem or the requested capability. - -## Details -- For bugs: what’s broken and where? -- For features: what should be added or improved? - -## Steps to Reproduce (bugs) -1. … -2. … -3. … - -## Expected vs Actual (bugs) -- Expected: -- Actual: - -## Environment (bugs) -- Bitcore version: -- Node.js version: -- OS: -- Any relevant config: - -## Screenshots/Logs (optional) -Attach images or paste logs that help illustrate the issue. - -## Proposed Solution (optional) -If you have an idea for how to fix or implement this, describe it here. - -## Additional Context (optional) -Links, related issues, or other info. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..b2ee4dee78 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +--- +name: Bug report 🐞 +about: Report a problem or unexpected behavior +labels: ["bug"] +--- + +### Describe the bug + +A clear and concise description of what the bug is. + +### Expected behavior +A clear and concise description of what you expected to happen. + +### Screenshots +If applicable, add screenshots to help explain your problem. + +### Environment +Relevant information about your environment: +- OS and version (e.g. Ubuntu 22.04, macOS 15, Windows 11) +- Node.js version + +If one of the following is relevant to the error (such as in the error message) include: +- Network(s) used (e.g. BTC mainnet/testnet, BCH, ETH, DOGE, etc.) +- The package(s) version +- Database and version (e.g. MongoDB 7.x) +- Browser +- RAM +- CPU +- Disk size +- Disk Type (HD/SDD) + +### Steps to reproduce +1\. + +2\. + +... diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..e7a75beb9d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,13 @@ +--- +name: Feature request 🚀 +about: Suggest a new feature for this project +labels: ["feature request"] +--- + +## Make sure... +This feature is not an [existing issue](https://github.com/bitpay/bitcore/issues) + +This feature has not already been rejected in a [closed issue](https://github.com/bitpay/bitcore/issues?q=is%3Aissue%20state%3Aclosed) + +## What is being added and why? +Describe what is being added. Why do you want this feature? What problem(s) does this solve? diff --git a/.github/PR_REQUEST_TEMPLATE.md b/.github/PR_REQUEST_TEMPLATE.md index ad170d583e..44c4ad1cc8 100644 --- a/.github/PR_REQUEST_TEMPLATE.md +++ b/.github/PR_REQUEST_TEMPLATE.md @@ -1,104 +1,14 @@ -# PR Request Template +## Description +What does this PR do? What is it solving or adding? -Thank you for contributing to BitPay Bitcore! +Does an [existing PR](https://github.com/bitpay/bitcore/pulls) already do this? +Does a [closed/rejected PR](https://github.com/bitpay/bitcore/pulls?q=is%3Apr+is%3Aclosed+) already do this? -Please fill out the sections below to help us review your pull request efficiently. +🙏 Please adhere to the coding conventions used throughout this monorepo (indentation, +accurate comments, etc.) and any other requirements (such as test coverage). -## Summary +✍️ **All commits must be [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)** and `Verified` in GitHub. -- What does this PR do? -- Why is it needed? +Create a fork and clone it as described in [CONTRIBUTING.md](https://github.com/bitpay/bitcore/tree/master/CONTRIBUTING.md) -### Title Conventions - -Prefix the PR title with a component tag for clarity, following patterns seen in recent work (e.g., kajoseph’s PRs): -- Examples: [BWS], [BCN], [CLI], [CWC], [BCC], [Libs], [BWC] -- For broad repo-wide changes, use [*] or a suitable umbrella tag. - -### Component(s) - -Select one or more affected components: -- [ ] BWS (Bitcore Wallet Service) -- [ ] BCN (Bitcore Node) -- [ ] CLI (bitcore-cli) -- [ ] CWC (Crypto Wallet Core) -- [ ] BCC (bitcore-client) -- [ ] Libs (bitcore-libs) -- [ ] BWC (bitcore-wallet-client) -- [ ] Other: __________ - -## Type of Change - -- [ ] Bug fix -- [ ] New feature -- [ ] Refactor -- [ ] Performance improvement -- [ ] Test-related (tests/coverage) -- [ ] Docs update -- [ ] Build/CI -- [ ] Chore/Maintenance - -## Changes - -- List the key changes introduced by this PR. - -## Breaking Changes - -- [ ] No breaking changes -- [ ] Breaking changes (describe below) - -If breaking, explain the impact and migration path: -- Impact: -- Migration steps: - -## Testing - -- [ ] Unit tests added/updated -- [ ] Integration tests added/updated -- [ ] Manual testing performed - -Describe the testing strategy and results: -- Steps to reproduce/verify: -- Environments tested: -- Relevant test cases: - -## Screenshots or Logs (if applicable) - -- Include any relevant output, screenshots, or logs. - -## Security Considerations - -- [ ] No security-related changes -- [ ] Security-related changes (describe below) - -If security-related, explain risk and mitigation: -- Risk: -- Mitigation: -- Additional notes: - -## Documentation - -- [ ] README/Docs updated -- [ ] Not required - -Links or notes for doc updates: -- Docs PR/Section: -- User-facing changes documented: - -## Checklist - -- [ ] Title follows component tag convention (e.g., [BWS], [BCN], [CLI], [CWC], [BCC], [Libs], [BWC], [*]) -- [ ] Linked to an existing issue/discussion (e.g., closes #123) -- [ ] Code follows project style and lint rules -- [ ] Commit messages follow Conventional Commits -- [ ] All tests pass locally (`npm test` or applicable commands) -- [ ] CI checks pass (when applicable) -- [ ] Includes necessary configuration updates (if any) -- [ ] No sensitive information committed -- [ ] Reviewed performance implications (if relevant) -- [ ] Verified cross-platform compatibility (Linux/macOS/Windows if applicable) - -## Additional Notes - -- Anything reviewers should pay extra attention to? -- Dependencies or follow-ups required? \ No newline at end of file +Add a tag for the modified package(s). For example, BCN for bitcore-node, CWC for crypto-wallet-core, and BWC for bitcore-wallet-client. From 7ffa66f45b63cd5d55af2d3b108f180586979814 Mon Sep 17 00:00:00 2001 From: Micah Maphet Date: Mon, 5 Jan 2026 14:48:19 -0500 Subject: [PATCH 4/5] refactored PR_REQUEST_TEMPLATE --- .github/PR_REQUEST_TEMPLATE.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/.github/PR_REQUEST_TEMPLATE.md b/.github/PR_REQUEST_TEMPLATE.md index 44c4ad1cc8..db9329bfe5 100644 --- a/.github/PR_REQUEST_TEMPLATE.md +++ b/.github/PR_REQUEST_TEMPLATE.md @@ -1,14 +1,13 @@ ## Description -What does this PR do? What is it solving or adding? +This PR... -Does an [existing PR](https://github.com/bitpay/bitcore/pulls) already do this? -Does a [closed/rejected PR](https://github.com/bitpay/bitcore/pulls?q=is%3Apr+is%3Aclosed+) already do this? +* Describe what this PR does here +* Explain why this PR is needed -🙏 Please adhere to the coding conventions used throughout this monorepo (indentation, -accurate comments, etc.) and any other requirements (such as test coverage). +* [ ] I have read [CONTRIBUTING.md](https://github.com/bitpay/bitcore/tree/master/CONTRIBUTING.md) and verified that this PR follows the guidelines and requirements outlined in it. +* [ ] I have added the appropriate package tag(s) (e.g. `BWC` if modifying the bitcore-wallet-client package, `CLI` if modifying the bitcore-cli package, etc.) +* [ ] Does an [existing PR](https://github.com/bitpay/bitcore/pulls) already do this? +* [ ] Does a [closed/rejected PR](https://github.com/bitpay/bitcore/pulls?q=is%3Apr+is%3Aclosed+) already do this? -✍️ **All commits must be [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)** and `Verified` in GitHub. - -Create a fork and clone it as described in [CONTRIBUTING.md](https://github.com/bitpay/bitcore/tree/master/CONTRIBUTING.md) - -Add a tag for the modified package(s). For example, BCN for bitcore-node, CWC for crypto-wallet-core, and BWC for bitcore-wallet-client. +## Testing Notes +Add any helpful notes for reviewers to test your code here. From 964111b71529fed55aa1f49476ae351551fd358d Mon Sep 17 00:00:00 2001 From: Micah Maphet Date: Tue, 6 Jan 2026 16:13:53 -0500 Subject: [PATCH 5/5] small review changes to issue and PR templates --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ---- .github/ISSUE_TEMPLATE/feature_request.md | 4 ++-- .github/PR_REQUEST_TEMPLATE.md | 8 ++++---- 3 files changed, 6 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index b2ee4dee78..78e41f8244 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -31,7 +31,3 @@ If one of the following is relevant to the error (such as in the error message) ### Steps to reproduce 1\. - -2\. - -... diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index e7a75beb9d..e5f953eed7 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -5,9 +5,9 @@ labels: ["feature request"] --- ## Make sure... -This feature is not an [existing issue](https://github.com/bitpay/bitcore/issues) +* [ ] This feature is not an [existing issue](https://github.com/bitpay/bitcore/issues) -This feature has not already been rejected in a [closed issue](https://github.com/bitpay/bitcore/issues?q=is%3Aissue%20state%3Aclosed) +* [ ] This feature has not already been rejected in a [closed issue](https://github.com/bitpay/bitcore/issues?q=is%3Aissue%20state%3Aclosed) ## What is being added and why? Describe what is being added. Why do you want this feature? What problem(s) does this solve? diff --git a/.github/PR_REQUEST_TEMPLATE.md b/.github/PR_REQUEST_TEMPLATE.md index db9329bfe5..f394c35d5a 100644 --- a/.github/PR_REQUEST_TEMPLATE.md +++ b/.github/PR_REQUEST_TEMPLATE.md @@ -1,13 +1,13 @@ ## Description This PR... -* Describe what this PR does here -* Explain why this PR is needed +Describe what this PR does here +Explain why this PR is needed +## Make sure... * [ ] I have read [CONTRIBUTING.md](https://github.com/bitpay/bitcore/tree/master/CONTRIBUTING.md) and verified that this PR follows the guidelines and requirements outlined in it. * [ ] I have added the appropriate package tag(s) (e.g. `BWC` if modifying the bitcore-wallet-client package, `CLI` if modifying the bitcore-cli package, etc.) -* [ ] Does an [existing PR](https://github.com/bitpay/bitcore/pulls) already do this? -* [ ] Does a [closed/rejected PR](https://github.com/bitpay/bitcore/pulls?q=is%3Apr+is%3Aclosed+) already do this? +* [ ] I have verified that this is not an existing PR ([open](https://github.com/bitpay/bitcore/pulls) or [closed](https://github.com/bitpay/bitcore/pulls?q=is%3Apr+is%3Aclosed+)) ## Testing Notes Add any helpful notes for reviewers to test your code here.