Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (29 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

39 lines (29 loc) · 1.1 KB
Raw

Contributing

Contributions should go through pull requests against main or a documented release branch.

Development Rules

  • Keep changes narrowly scoped.
  • Preserve upstream attribution when incorporating external patches.
  • Do not make consensus or storage-format changes without a design note.
  • Keep nodeos, cleos, and keosd compatibility unless a release plan says otherwise.
  • Update packaging and operator docs when behavior affects installation, upgrades, or runtime configuration.

Commit And PR Expectations

Pull requests should include:

  • a short summary
  • compatibility impact
  • tests run
  • upstream or Community Edition references, if any

For backports or incorporated upstream patches, include the source commit or PR URL in the PR description.

Local Verification

At minimum, run syntax checks before opening a PR when touching the relevant files:

bash -n tools/tweak-deb.sh
sh -n scripts/postinst
sh -n scripts/prerm
perl -c tools/pinned.pl
python3 -m py_compile tests/TestHarness/Node.py tests/TestHarness/queries.py tests/TestHarness/testUtils.py tests/cli_test.py