docs: add Technical Charter and restructure governance documentation - #1664
Open
kriswest wants to merge 2 commits into
Open
docs: add Technical Charter and restructure governance documentation#1664kriswest wants to merge 2 commits into
kriswest wants to merge 2 commits into
Conversation
…d plus cross-firm reviews
✅ Deploy Preview for endearing-brigadeiros-63f9d0 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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.40% 90.31% -0.10%
==========================================
Files 88 88
Lines 8680 8680
Branches 1608 1608
==========================================
- Hits 7847 7839 -8
- Misses 802 810 +8
Partials 31 31 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
7 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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)