docs: add Technical Charter and restructure governance documentation - #1664
docs: add Technical Charter and restructure governance documentation#1664kriswest wants to merge 4 commits into
Conversation
…d plus cross-firm reviews
✅ Deploy Preview for endearing-brigadeiros-63f9d0 canceled.
|
github-actions
Bot
added
the
documentation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1664 +/- ##
==========================================
+ Coverage 90.17% 90.26% +0.08%
==========================================
Files 89 89
Lines 8896 8896
Branches 1657 1657
==========================================
+ Hits 8022 8030 +8
+ Misses 842 834 -8
Partials 32 32 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
We discussed this at the meeting on Monday and had broad approval from those present. In the spirit of its own contents it would be good to get as many maintainer approvals on it as we can. Hence @finos/git-proxy-maintainers please take a look and give this approval before I merge later in the week. |
coopernetes
left a comment
coopernetes
left a comment
There was a problem hiding this comment.
Just one minor comment to set the right expectation re: deployment assets.
| Out of scope: | ||
|
|
||
| - Organisation-specific policy content or plugin implementations | ||
| - Hosting, infrastructure, or operational support for production deployments |
There was a problem hiding this comment.
I get the spirit of this statement. However, this is in conflict with the project providing a Docker image for deployment use. I would classify that as "hosting" or "infrastructure" to a degree (firms are of course free to pull in the project from source and build/deploy the app as they see fit). It's not unreasonable for the project to provide some runnable artifact and offer a degree of support (in line with SECURITY.md and responsible disclosure policies).
If the purpose of this is to say "finos/git-proxy the project cannot provide operational support such as support for hosting Git Proxy or required infrastructure to operate Git Proxy", then I'm good with this.
| - Hosting, infrastructure, or operational support for production deployments | |
| - Operational support for production deployments |
3 participants
Description
Adds a Technical Charter (
CHARTER.md) and restructures the project's governance documentation to align with the FINOS software-project-blueprint standard.Key changes:
CHARTER.md(new) — Defines GitProxy's mission, scope, maintainer structure, IP framework, and amendment process.CONTRIBUTING.md(restructured) — Governance content (roles, contribution rules, voting, dispute resolution) added above the existing development guide. Includes a new Cross-Firm Review clause requiring significant changes (new features, breaking changes) to be approved by a maintainer from a different organisation, while explicitly exempting routine maintenance. Adds a Dispute Resolution process (consensus → community meeting → vote → FINOS tie-break).website/docs/development/contributing.mdx(slimmed) — Governance content removed; page now focuses on contribution mechanics and links toCONTRIBUTING.mdandCHARTER.mdfor governance details.This is a governance-only change with no code modifications.
Related Issue
Resolves #1660
Checklist
General
Documentation
Configuration
config.schema.json) was modified:npm run generate-config-types)npm run gen-schema-doc)Tests
npm test)npm run lintandnpm run format:check)npm run check-types)