https://github.com/docknetwork/planning
https://github.com/docknetwork/planning
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/docknetwork/planning
- Owner: docknetwork
- License: apache-2.0
- Created: 2020-04-30T18:09:05.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-01-22T18:01:10.000Z (over 5 years ago)
- Last Synced: 2023-03-04T04:50:07.241Z (over 3 years ago)
- Size: 121 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Dock RFCs and Specs
## RFC
Anyone is free to propose new developments by writing an RFC (request for comment). Submit an RFC by copying and filling the template [rfc/0000-template.md](./rfc/0000-template.md). Create new file `rfc/xxxx-feature-name.md`. When you are ready for your feature to be reviewed, submit a pr.
The team makes a final decidsion after the RFC has been discussed and the benefits and drawbacks are well understood. At that point the rfc is either
- approved (merged)
- rejected (pr is closed)
- or postponed (pr tagged with the "postponed" label and closed)
## Spec
An implementation spec is the optional next step after the RFC. Copy the template [spec/0000-template.md](./spec/0000-template.md) over to `spec/xxxx-feature-name.md` to get started. The spec can be submitted in the same PR as your RFC or it can be submitted separately.
## Markdown Formatting
Couple arbitrary decisions for style consistency:
- Include double line breaks before and after elements e.g. `# Headers` or code blocks.
- Don't perform manual line-wrapping.
---
Want to change something about this repo? Go ahead. The guidelines provided are intended to help you; they need not be set-in-stone.
*Thanks to https://eng.lyft.com/awesome-tech-specs-86eea8e45bb9 for the guide on which these templates were initially based.*
## License
The contents of this repository are licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or [MIT license](LICENSE-MIT), at your option.