-
Notifications
You must be signed in to change notification settings - Fork 0
docs: unify README with the shared skeleton and expand the org profile #4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,61 @@ | ||
| <div align="center"> | ||
|
|
||
| <img src="https://mux-lang.dev/img/mux-logo.png" alt="Mux Logo" width="120"> | ||
|
|
||
| # .github | ||
|
|
||
| Organization-level defaults for the [muxlang](https://github.com/muxlang) org: | ||
| **Organization-level defaults for the [muxlang](https://github.com/muxlang) org** | ||
|
|
||
| [](LICENSE) | ||
| [](https://sonarcloud.io/summary/new_code?id=muxlang_.github) | ||
|
|
||
| </div> | ||
|
|
||
| Shared community-health files, the org profile, and the canonical sources that | ||
| sync labels and issue templates into every repo. | ||
|
|
||
| --- | ||
|
|
||
| ## What's here | ||
|
|
||
| | Path | What it is | | ||
| |------|------------| | ||
| | `profile/README.md` | The org profile shown on the [organization page](https://github.com/muxlang) | | ||
| | `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md` | Shared community-health defaults | | ||
| | `labels/` | Canonical label YAML and per-repo overlays | | ||
| | `templates/<repo>/` | Canonical issue template sources synced to each repo | | ||
| | `scripts/sync-labels.sh` | Apply label YAML to org repos (`gh` CLI required) | | ||
| | `scripts/sync-templates.sh` | Copy `templates/<repo>/` into a repo checkout | | ||
| | `scripts/validate-labels.py` | Diff live labels against the canonical YAML; exits nonzero on drift | | ||
|
|
||
| --- | ||
|
|
||
| - `profile/README.md` - the org profile shown on the [organization page](https://github.com/muxlang). | ||
| - `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md` - shared community-health defaults. | ||
| - `labels/` - canonical label YAML and per-repo overlays. | ||
| - `templates/<repo>/` - canonical issue template sources synced to each repo. | ||
| - `scripts/sync-labels.sh` - apply label YAML to org repos (`gh` CLI required). | ||
| - `scripts/sync-templates.sh` - copy `templates/<repo>/` into a repo checkout. | ||
| - `scripts/validate-labels.py` - diff live labels against the canonical YAML; | ||
| exits nonzero on drift (run after any sync). | ||
| ## How syncing works | ||
|
|
||
| Per-repo `.github/ISSUE_TEMPLATE/`, `.github/workflows/issue-triage.yml`, and | ||
| `.github/labels.yml` are synced from `templates/` here via | ||
| `scripts/sync-templates.sh`. Do not copy templates or invent labels in individual | ||
| repos - change them here and re-sync. | ||
|
|
||
| Policy and workflow rules: | ||
| [mux-context/docs/repo-governance.md](https://github.com/muxlang/mux-context/blob/main/docs/repo-governance.md). | ||
|
|
||
| Per-repo `.github/ISSUE_TEMPLATE/`, `.github/workflows/issue-triage.yml`, and | ||
| `.github/labels.yml` are synced from `templates/` here via `scripts/sync-templates.sh`. | ||
| Do not copy templates or invent labels in individual repos. | ||
| --- | ||
|
|
||
| ## Related repositories | ||
|
|
||
| | Repo | What it is | | ||
| |------|------------| | ||
| | [mux-compiler](https://github.com/muxlang/mux-compiler) | The language, compiler, and CLI (the canonical Mux version) | | ||
| | [mux-runtime](https://github.com/muxlang/mux-runtime) | Runtime + standard library linked by compiled programs | | ||
| | [mux-website](https://github.com/muxlang/mux-website) | Docs site (mux-lang.dev) and playground UI | | ||
| | [mux-website-api](https://github.com/muxlang/mux-website-api) | Compile/run API behind the playground | | ||
| | [tree-sitter-mux](https://github.com/muxlang/tree-sitter-mux) | Tree-sitter grammar + highlight queries | | ||
| | [mux-syntax-highlighting](https://github.com/muxlang/mux-syntax-highlighting) | TextMate grammar, VSCode extension, canonical syntax spec | | ||
| | [mux-context](https://github.com/muxlang/mux-context) | Cross-repo architecture, design rationale, glossary, releases | | ||
|
|
||
| --- | ||
|
|
||
| ## License | ||
|
|
||
| [MIT](LICENSE) - Maintained by [Derek Corniello](https://github.com/DerekCorniello) | ||
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.