diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..3187f95 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,7 @@ +# Code owners for the Code Architects Enterprise Solution Platform. +# +# These owners are automatically requested for review on pull requests and are +# the maintainers referenced in GOVERNANCE.md. Replace the entry below with a +# GitHub team (e.g. @codearchitects/esp-maintainers) once one is created. + +* @gmasci-ca diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..0f853f9 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,25 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +All packages in the repository share a single version. + +## [10.0.0] + +### Added + +- Initial public open-source release of the Code Architects Enterprise Solution + Platform under the Apache License 2.0. +- `CodeArchitects.Platform.*` libraries — messaging, actors, state management, + data access (ADO.NET, Entity Framework Core, MongoDB), application services, + policy management and GraphQL — published to NuGet.org from a single .NET + solution, with first-class [Dapr](https://dapr.io/) support. +- Project legal and governance documentation: `LICENSE`, `NOTICE`, + `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, `SECURITY.md`, `GOVERNANCE.md`, + `SUPPORT.md`, issue/PR templates, and `.github/CODEOWNERS`. +- Continuous integration (build + test), a NuGet publish workflow with + semantic/pre-release versioning, an SBOM step, and Dependabot configuration. + +[10.0.0]: https://github.com/codearchitects/CodeArchitects.EnterprisePlatform.Server/releases/tag/v10.0.0 diff --git a/GOVERNANCE.md b/GOVERNANCE.md new file mode 100644 index 0000000..d6c1846 --- /dev/null +++ b/GOVERNANCE.md @@ -0,0 +1,52 @@ +# Project Governance + +This document describes how the Code Architects Enterprise Solution Platform +project is governed and how decisions are made. + +## Overview + +The project is maintained by **Code Architects S.r.l.** and is open to +contributions from the community under the [Apache License 2.0](LICENSE). + +## Roles + +### Users + +Anyone who uses the libraries. Users are encouraged to participate by reporting +issues, requesting features, and joining discussions. + +### Contributors + +Anyone who submits a contribution (code, documentation, tests, reviews, triage) +to the project. Contributions are accepted via pull request and must follow +[CONTRIBUTING.md](CONTRIBUTING.md). + +### Maintainers + +Maintainers are responsible for the overall health and direction of the project. +They review and merge pull requests, triage issues, manage releases, and uphold +the [Code of Conduct](CODE_OF_CONDUCT.md). Maintainers are appointed by Code +Architects S.r.l. and are listed in [.github/CODEOWNERS](.github/CODEOWNERS). + +## Decision making + +Day-to-day decisions are made by maintainers through the normal review process: + +- **Pull requests** require approval from at least one maintainer who is not the + author before merging. +- **Non-trivial or breaking changes** should first be discussed in an issue to + reach rough consensus. +- Where consensus cannot be reached, Code Architects S.r.l., as the project + steward, makes the final decision. + +## Releases + +All packages share a single version and are released together. Releases are cut +by maintainers via the automated publish workflow — either by running it manually +from the Actions tab or by publishing a GitHub Release. See +[README.md](README.md#versioning--releases) for details. + +## Changes to governance + +This document may be amended by the maintainers. Material changes will be made +via pull request so the community can review them. diff --git a/README.md b/README.md index b335d9f..15a10b8 100644 --- a/README.md +++ b/README.md @@ -59,10 +59,31 @@ pip install mkdocs mkdocs serve ``` +## Versioning & releases + +All packages share a **single version**, defined once in +[`Directory.Build.props`](Directory.Build.props). Versioning follows +[Semantic Versioning](https://semver.org/), with the major version aligned to the +.NET release wave (the first public release is `10.0.0`). Internal project +references are pinned to the same shared version at pack time. + +Releases are cut by maintainers through the +[publish workflow](.github/workflows/publish.yml), in one of two ways: + +- **Manually** from the *Actions* tab — pick a bump type (`patch`/`minor`/`major`, + or a `prepatch`/`preminor`/`premajor`/`prerelease` with a `beta`/`rc`/`alpha`/ + `canary`/`next` identifier). A `dry_run` option is available. +- **By publishing a GitHub Release** with a tag such as `v10.1.0` or `v10.1.0-rc.1`. + +Pre-release versions carry a suffix (e.g. `10.1.0-beta.0`); consumers opt in to +them with `--prerelease`. See the [CHANGELOG](CHANGELOG.md) for release notes. + ## Contributing Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) and our [Code of Conduct](CODE_OF_CONDUCT.md) before opening an issue or pull request. +See [GOVERNANCE.md](GOVERNANCE.md) for how the project is run and +[SUPPORT.md](SUPPORT.md) for how to get help. ## Security diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000..0103176 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,33 @@ +# Support + +Thanks for using the Code Architects Enterprise Solution Platform! Here is how +to get help. + +## Questions and usage help + +- **Read the docs first** — start with the [README](README.md), the guides under + [`docs/`](docs/), and each package's own README. +- **Search existing issues** — your question may already be answered. +- **Open a discussion or issue** — if you can't find an answer, open a GitHub + issue and describe what you're trying to do. + +## Reporting bugs and requesting features + +Use the GitHub issue templates: + +- **Bug report** — for something that isn't working as documented. +- **Feature request** — for a new capability or improvement. + +Please provide a minimal reproduction, versions (.NET SDK, target framework, and +the affected `CodeArchitects.Platform.*` package version) and expected vs. actual +behavior. + +## Security issues + +Do **not** open a public issue for security problems. Follow the private +reporting process in [SECURITY.md](SECURITY.md). + +## Commercial support + +For commercial support and enterprise inquiries, contact +[Code Architects S.r.l.](https://www.codearchitects.com/).