rusk icon indicating copy to clipboard operation
rusk copied to clipboard

Ensure all CHANGELOG of the repos uses issues numbers

Open ZER0 opened this issue 1 year ago • 0 comments

Summary

For some reason we started to have in our CHANGELOG.md PRs numbers instead of the issues numbers. It's also possible that some CHANGELOG now have mixed references (some issues, some PRs). We should ensure all the CHANGELOG of this monorepo are consistent in using issue numbers:

  • [ ] ./consensus/CHANGELOG.md
  • [ ] ./circuits/license/CHANGELOG.md
  • [ ] ./circuits/transfer/CHANGELOG.md
  • [ ] ./contracts/stake/CHANGELOG.md
  • [ ] ./contracts/license/CHANGELOG.md
  • [ ] ./rusk-abi/CHANGELOG.md
  • [x] #1368
  • [ ] ./rusk-recovery/CHANGELOG.md
  • [ ] ./rusk/CHANGELOG.md

Detailed Description (optional)

While it's true that the two should be linked, making it easy to jump from one to another, ideally the number should be inferred from the commit message, which obviously contains "resolves ". Furthermore, all discussion about a specific problem should be in the issue itself, while discussion about the code for solving the issue should be in the PR. Therefore, the issue should be the first entry point: review the problem, then proceed to the solution, rather than the other way around.

ZER0 avatar Feb 09 '24 08:02 ZER0