Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (20 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 1.5 KB

Contributing to flow

Thank you for your interest in contributing to the Flow network. This repository hosts protocol specifications, interface definitions (protobuf and OpenAPI), node operator docs, governance agendas, and the mainnet spork history.

Ways to contribute

  • Protocol improvements: open a Flow Improvement Proposal (FLIP) for substantive protocol or standard changes.
  • Interface definitions: suggest updates to the protobuf schema (protobuf/) or the Access API OpenAPI specification (openapi/) by opening a pull request.
  • Node operator docs: improvements to the nodeoperators/ directory are welcome.
  • Spork records: corrections to sporks.json should reference the upstream source for the change.

Workflow

  1. Fork this repository and create a branch from master.
  2. Make your change, keeping commits focused and well-described.
  3. Open a pull request describing the motivation and the scope of the change.
  4. Respond to review feedback. Maintainers may ask for adjustments or request that larger changes go through the FLIP process.

Code of conduct

All contributors are expected to follow the Code of Conduct.

Security

Please do not file public issues for security vulnerabilities. See SECURITY.md for responsible disclosure instructions.

Community