Skip to content

Commit f1adb3e

Browse files
committed
chore: move style-guides into contributing/ and update sync action
Move style-guides/ under contributing/ to further declutter root. Update sync-community-docs workflow for new paths of CODE_OF_CONDUCT and AI-POLICY. Update all internal links in CONTRIBUTING.md and AGENTS.md.
1 parent 70a86be commit f1adb3e

15 files changed

Lines changed: 10 additions & 12 deletions

File tree

.github/workflows/sync-community-docs.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ on:
66
branches: [main]
77
paths:
88
- 'CONTRIBUTING.md'
9-
- 'CODE_OF_CONDUCT.md'
9+
- 'contributing/CODE_OF_CONDUCT.md'
1010
- 'SECURITY.md'
11-
- 'AI-POLICY.md'
11+
- 'contributing/AI-POLICY.md'
1212

1313
jobs:
1414
sync:
@@ -27,9 +27,9 @@ jobs:
2727
- name: Copy community docs
2828
run: |
2929
cp CONTRIBUTING.md dotgithub/
30-
cp CODE_OF_CONDUCT.md dotgithub/
30+
cp contributing/CODE_OF_CONDUCT.md dotgithub/
3131
cp SECURITY.md dotgithub/
32-
cp AI-POLICY.md dotgithub/
32+
cp contributing/AI-POLICY.md dotgithub/
3333
3434
- name: Commit and push
3535
working-directory: dotgithub

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Thank you for your interest in contributing to MUXI!
1212
- **[GIT-WORKFLOW.md](https://github.com/muxi-ai/muxi/blob/main/contributing/GIT-WORKFLOW.md)** - Branching and release process
1313
- **[ARCHITECTURE.md](https://github.com/muxi-ai/muxi/blob/main/ARCHITECTURE.md)** - Understand the system
1414
- **[REPOSITORIES.md](https://github.com/muxi-ai/muxi/blob/main/REPOSITORIES.md)** - All MUXI repositories
15-
- **[Style Guides](https://github.com/muxi-ai/muxi/blob/main/style-guides/)** - Language-specific coding conventions
15+
- **[Style Guides](https://github.com/muxi-ai/muxi/blob/main/contributing/style-guides/)** - Language-specific coding conventions
1616
- **[AGENTS.md](https://github.com/muxi-ai/muxi/blob/main/contributing/AGENTS.md)** - AI assistant context (template for all repos)
1717

1818

contributing/AGENTS.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ For full architecture details, see **[ARCHITECTURE.md](https://github.com/muxi-a
2222

2323
- **Branch workflow:** `develop``rc``main` (PRs target `develop`)
2424
- **Commits:** [Conventional Commits](https://www.conventionalcommits.org/)
25-
- **Style:** See [style-guides/](./style-guides/) for language-specific conventions
25+
- **Style:** See [style-guides/](./contributing/style-guides/) for language-specific conventions
2626

2727
### More info
2828

29-
The `muxi` meta-repo (https://github.com/muxi-ai/muxi) contains most everything you need to understand the MUXI stack, including docs, development workflows, style-guides, etc.
29+
The `muxi` meta-repo (https://github.com/muxi-ai/muxi) contains most everything you need to understand the MUXI stack, including docs, development workflows, contributing guides, etc.
3030

3131

3232
## This Repository
@@ -53,10 +53,8 @@ muxi/
5353
├── GIT-WORKFLOW.md # Branching and release process
5454
├── REPOSITORIES.md # All MUXI repositories
5555
├── SECURITY.md # Security policy
56-
├── style-guides/ # Language-specific coding standards
57-
│ ├── go.md
58-
│ ├── python.md
59-
│ ├── typescript.md
56+
├── contributing/ # Contributor docs and style guides
57+
│ ├── style-guides/
6058
│ └── ...
6159
└── docs/ # Additional documentation
6260
```
@@ -73,7 +71,7 @@ When making changes to this repo:
7371
### Related Resources
7472

7573
- [CONTRIBUTING.md](./CONTRIBUTING.md) - How to contribute
76-
- [style-guides/](./style-guides/) - Language-specific conventions
74+
- [style-guides/](./contributing/style-guides/) - Language-specific conventions
7775
- [ARCHITECTURE.md](./ARCHITECTURE.md) - Detailed architecture
7876

7977

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)