The Revision section in the README has several inconsistencies that make the change history hard to follow.
Current snippet:
BNB Smart Chain White Paper
Revision
Version 0.1, 2020/04/17, initial publish.
Version 0.1, 2020/05/25, add Chinese version translated by community members.
Version 0.1, 2020/11/10, add Filipino version translated by @ricoz
Version 0.2, 2024/8/7, revise the whitepaper after BC fusion
Problems
Repeated version number 0.1 for multiple changes — should follow semantic versioning (0.1.0, 0.1.1, 0.1.2, 0.2.0).
Inconsistent date formats: 2020/04/17 vs 2024/8/7. Prefer ISO-8601 YYYY-MM-DD.
Inconsistent phrasing/style: “initial publish” vs “add…”. Use a consistent tense and style.
Ambiguous “BC fusion”. Please expand (e.g., “BSC ↔ Beacon Chain fusion”) and link to the official announcement.
No links to translations (Chinese, Filipino), and the contributor mention @ricoz lacks a profile link.
Changelog mixed into README. Consider moving detailed history to CHANGELOG.md.
Expected behavior
A clear, consistent revision history using SemVer, ISO dates, uniform phrasing, and links to relevant resources.
Proposed fix
Replace the Revision block with:
Revision History
- v0.1.0 — 2020-04-17 — Initial publication.
- v0.1.1 — 2020-05-25 — Added Chinese translation (community).
- v0.1.2 — 2020-11-10 — Added Filipino translation (contributor: @ricoz).
- v0.2.0 — 2024-08-07 — Revised after BSC ↔ Beacon Chain fusion ([announcement]).
Additional actions:
Add links to the translation files (or create a translations/ directory).
Create a CHANGELOG.md following Keep a Changelog format and link it from the README.
Tag Git releases: v0.1.0, v0.1.1, v0.1.2, v0.2.0.
Clarify “BC fusion” wording in the white paper and link the official announcement.
Steps to reproduce
Open the README.
Scroll to Revision.
Note repeated version number, mixed date formats, and ambiguous “BC fusion”.
Additional notes
Happy to submit a PR with these changes if this approach sounds good. 🙌
The Revision section in the README has several inconsistencies that make the change history hard to follow.
Current snippet:
BNB Smart Chain White Paper
Revision
Version 0.1, 2020/04/17, initial publish.
Version 0.1, 2020/05/25, add Chinese version translated by community members.
Version 0.1, 2020/11/10, add Filipino version translated by @ricoz
Version 0.2, 2024/8/7, revise the whitepaper after BC fusion
Problems
Repeated version number 0.1 for multiple changes — should follow semantic versioning (0.1.0, 0.1.1, 0.1.2, 0.2.0).
Inconsistent date formats: 2020/04/17 vs 2024/8/7. Prefer ISO-8601 YYYY-MM-DD.
Inconsistent phrasing/style: “initial publish” vs “add…”. Use a consistent tense and style.
Ambiguous “BC fusion”. Please expand (e.g., “BSC ↔ Beacon Chain fusion”) and link to the official announcement.
No links to translations (Chinese, Filipino), and the contributor mention @ricoz lacks a profile link.
Changelog mixed into README. Consider moving detailed history to CHANGELOG.md.
Expected behavior
A clear, consistent revision history using SemVer, ISO dates, uniform phrasing, and links to relevant resources.
Proposed fix
Replace the Revision block with:
Revision History
Additional actions:
Add links to the translation files (or create a translations/ directory).
Create a CHANGELOG.md following Keep a Changelog format and link it from the README.
Tag Git releases: v0.1.0, v0.1.1, v0.1.2, v0.2.0.
Clarify “BC fusion” wording in the white paper and link the official announcement.
Steps to reproduce
Open the README.
Scroll to Revision.
Note repeated version number, mixed date formats, and ambiguous “BC fusion”.
Additional notes
Happy to submit a PR with these changes if this approach sounds good. 🙌