Page MenuHomePhabricator
Differential D14259

[electrum] documentation overhaul and dedicated CONTRIBUTING.md
ClosedPublic
Actions

Authored by PiRK on Jul 12 2023, 11:22.

Details

Reviewers
Fabien
Group Reviewers
Restricted Project
Commits
rABCc1a2e09baa34: [electrum] documentation overhaul and dedicated CONTRIBUTING.md
Summary

Consolidate all developer documentation in a dedicated CONTRIBUTING.md file.

Rewrite the README.md to better describe the project and provide only info targeted at users (most technical/dev info moved to CONTRIBUTING.md).

Make the release notes file only about release notes (credits moved to README.md).

This diff mostly moves paragraphs and section between files, with only minor additions:

  • general description of the project and features in README.md
  • link the release notes in README.md
  • mention the functional tests in the "Running tests" section. This was previously undocumented.
Test Plan

proofreading

Diff Detail

Repository
rABC Bitcoin ABC
Branch
master
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 24468
Build 48536: Build Diffelectrum-tests
Build 48535: arc lint + arc unit

Event Timeline

PiRK created this revision.Jul 12 2023, 11:22
Herald added a reviewer: Restricted Project. · View Herald TranscriptJul 12 2023, 11:22
PiRK requested review of this revision.Jul 12 2023, 11:22
Harbormaster completed remote builds in B24467: Diff 41409.Jul 12 2023, 11:24
PiRK updated this revision to Diff 41410.Jul 12 2023, 11:26

readme touchup: regular users may also be interested in the telegram group for support

PiRK edited the summary of this revision. (Show Details)Jul 12 2023, 11:27
Harbormaster completed remote builds in B24468: Diff 41410.Jul 12 2023, 11:27
PiRK added inline comments.Jul 12 2023, 11:30
electrum/CONTRIBUTING.md
8

This is intentionally a web URL, in case it is read from the Electrum ABC mirror github repository.

PiRK updated this revision to Diff 41411.Jul 12 2023, 11:37

nits

Harbormaster completed remote builds in B24469: Diff 41411.Jul 12 2023, 11:38
PiRK mentioned this in D14253: contrib: add an extract-electrum.sh script to mirror monorepo commits to github.Jul 12 2023, 11:47
Fabien accepted this revision.Jul 12 2023, 13:42
Fabien added a subscriber: Fabien.

Consolidate all developer documentation a dedicated CONTRIBUTING.md file.

There is a word missing

This revision is now accepted and ready to land.Jul 12 2023, 13:42
PiRK edited the summary of this revision. (Show Details)Jul 12 2023, 13:53
Closed by commit rABCc1a2e09baa34: [electrum] documentation overhaul and dedicated CONTRIBUTING.md (authored by PiRK). · Explain WhyJul 12 2023, 14:05
This revision was automatically updated to reflect the committed changes.
PiRK added a commit: rABCc1a2e09baa34: [electrum] documentation overhaul and dedicated CONTRIBUTING.md.

Revision Contents
Changeset List

PathSize
18 lines
electrum/
174 lines
163 lines
6 lines

Diff 41410

View Options

CONTRIBUTING.md

Loading...
View Options

electrum/CONTRIBUTING.md

Loading...
View Options

electrum/README.md

Loading...
View Options

electrum/RELEASE-NOTES.md

Loading...