Freight Trust & Clearing Network
Contributors
Governance
Protocol
Releases
ARN Schema
arn:partition:service:region:account-id:resource-id arn:partition:service:region:account-id:resource-type/resource-id arn:partition:service:region:account-id:resource-type:resource-id
Community
New Community Structure and Startingpoint TBA
Protocol
Besu Configuration
see hyperledger besu cheatsheet
Guidelines
- Pool Operators
- Requirements
- Node Operators
- Requirements
Documentation Driven Development
There are many ways to drive open source development. Documenting the problem in the README gives a middle ground between technical and non-technical specifications. This allows organizing solutions to this challenge around community and documentation.
[...] a beautifully crafted library with no documentation is also damn near worthless. If your software solves the wrong problem or nobody can figure out how to use it, there’s something very bad going on.
- Readme Driven Development by Tom Preson-Werner
Conventions and Specifications
Using conventions, documentation and specifications make it easier to:
- communicate the problem you are solving
- ease onboarding
- build and use composable tools
- promote open source contribution and engagement
- promote issue and feature discussion on Github itself
Resources
- opensource.guide
- Github community profiles for public repositories
- Readme Driven Development
- pengwynn/flint
- Working Backwards
- Literate programming
- Hammock Driven Development
- Inversion and The Power of Avoiding Stupidity
- choosealicense.com
- The Documentation Compendium
Getting Started
To get started, fork or duplicate the repository. Then edit this file and delete everything above this line.
Contributing
How to contribute, build and release are outlined in CONTRIBUTING.md, BUILDING.md and RELEASING.md respectively. Commits in this repository follow the CONVENTIONAL_COMMITS.md specification.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
Warren G |
Arturo Cantera Carrasco |
This project follows the all-contributors specification. Contributions of any kind welcome!