Adopt shared policies and align ReleaseKit documentation and licensing
This commit is contained in:
21
README.md
21
README.md
@@ -1,3 +1,22 @@
|
||||
# ReleaseKit
|
||||
|
||||
ReleaseKit is an opinionated Go library that bundles common scripts and functions for releasing applications.
|
||||
ReleaseKit is being designed as an opinionated Go library and executable for a
|
||||
shared release process. The repository currently contains policies, architectural
|
||||
decisions, and implementation proposals. Go packages, commands, and release
|
||||
automation have not been implemented.
|
||||
|
||||
## Documentation
|
||||
|
||||
- [ReleaseKit proposal](docs/roadmap/releasekit.md): proposed publication, builds,
|
||||
version injection, and delivery, with the initial implementation plan.
|
||||
- [Contributor guide](docs/development.md): orientation, validation, and selective
|
||||
policy reading.
|
||||
- [Architecture policy](docs/policy/architecture.md): responsibility and dependency
|
||||
boundaries for development.
|
||||
- [ADR 0001](docs/adr/0001-public-facade.md): the accepted public facade decision.
|
||||
- [Policy adoption roadmap](docs/roadmap/policy.md): completed adoption and pending
|
||||
release bootstrap work.
|
||||
|
||||
ReleaseKit is licensed under the [LGPL v3.0 or later](COPYRIGHT).
|
||||
|
||||
[Open Source attribution notices](docs/oss/attribution.md) are available.
|
||||
|
||||
Reference in New Issue
Block a user