Skip to content

Tidy repository structure: reorganise content and fix typos#41

Merged
tlmquintino merged 9 commits intomainfrom
copilot/tidy-up-repository-structure
Mar 14, 2026
Merged

Tidy repository structure: reorganise content and fix typos#41
tlmquintino merged 9 commits intomainfrom
copilot/tidy-up-repository-structure

Conversation

Copy link
Contributor

Copilot AI commented Mar 7, 2026

Naming was inconsistent and Sofware Management Plan contained a typo. This PR standardises directory names to capitalised first letters (Title Case) with acronyms in full capitals, fixes the typo, reorganises misplaced content, and updates all cross-references.

Changes

Directory renames

All renamed to consistent Title Case with acronyms in full capitals:

  • Sofware Management PlanSoftware Management Plan (fixes typo)
  • Contributing ExternallyContributing Upstream (clarifies direction: ECMWF contributing to upstream/external projects)

Content reorganisation

  • Moved Legal/ai_contributions_to_software.mdGuidelines/ — the document is a development policy guideline, not a legal document
  • Moved Containerisation/README.mdGuidelines/Containerisation.md — consolidated under Guidelines
  • Moved Development Practices/Observability.mdGuidelines/Observability.md — consolidated under Guidelines
  • Moved External Contributions/README.mdGuidelines/external-contributions.md — consolidated under Guidelines
  • Removed empty Containerisation, Development Practices, and External Contributions directories
  • Fixed inconsistent lowercase Contributing Externally/readme.mdREADME.md

File renames

  • Renamed Guidelines/pr_guidelines.mdGuidelines/pull-requests.md

New index files

  • Added Guidelines/README.md — GitHub now renders a navigable overview instead of a bare file listing
  • Added Languages/README.md — same reason

Link updates

  • Root README.md: updated all links; added previously unlisted sections (Guidelines, Languages, Legal, Software Management Plan); Containerisation, Observability, and External Contributions now point into Guidelines/
  • Updated relative cross-references across Legal/, Software Management Plan/, Guidelines/
  • Updated hardcoded github.com/ecmwf/codex URLs in Project Maturity/README.md, ESEE/README.md, and Legal/requesting_new_repository.md
  • Fixed broken self-reference in ADR/ADR-Guidelines.md (./ADR/ADR-Index.md./ADR-Index.md)

Typo fixes

Pre-existing typos corrected in passing: sofware, maintenence, repostories, creatinsg, Adherance, managment, discalimer, meaningfull, immedietly, respository, guarrantees, cfii, and a stray > instead of ? in Languages/versioning.md.


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

…x typos

Co-authored-by: jameshawkes <11695815+jameshawkes@users.noreply.github.com>
Copilot AI changed the title [WIP] Refactor repository for improved structure and navigation Tidy repository structure: rename directories to lowercase kebab-case Mar 7, 2026
Copy link
Contributor Author

Copilot AI commented Mar 7, 2026

@jameshawkes The model claude-sonnet-4.6 is not available for your account. This can happen if the model was disabled by your organization's policy or if your Copilot plan doesn't include access to it.

You can try again without specifying a model (just @copilot) to use the default, or choose a different model from the model picker.

If you want to contact GitHub about this error, please mention the following identifier so they can better serve you: a6c1ef8e-a7e0-43fc-90a6-af6f7a0fc4a8

@jameshawkes
Copy link
Contributor

@copilot Does the layout of the content make sense? Is everything in the right subfolder? Please propose changes if required

…dex READMEs

Co-authored-by: jameshawkes <11695815+jameshawkes@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Mar 7, 2026

@copilot Does the layout of the content make sense? Is everything in the right subfolder? Please propose changes if required

Four structural issues were found and fixed in commit 0bc9a2f:

  1. legal/ai_contributions_to_software.mdguidelines/ — the document is "Policy Guidelines for AI-Assisted Code Generation", not a legal document.

  2. contributing-externally/contributing-upstream/ — the old name was easily confused with external-contributions/ (which covers the opposite direction: external people contributing to ECMWF). contributing-upstream clearly expresses the intent: ECMWF contributing to upstream external projects.

  3. contributing-externally/readme.mdREADME.md — inconsistent lowercase filename fixed.

  4. documentation/documentation-and-training/ — the folder's content explicitly covers both documentation and training; the earlier rename to just documentation dropped that context.

Two README.md index files were also added to guidelines/ and languages/, so GitHub renders a navigable overview when browsing those folders rather than a bare file listing.

Copilot AI changed the title Tidy repository structure: rename directories to lowercase kebab-case Tidy repository structure: rename directories and reorganise content Mar 7, 2026
@tlmquintino
Copy link
Member

@copilot please review this pull request and adapt it to the very latest changes and content of the repo.

Copilot AI and others added 2 commits March 13, 2026 23:42
Co-authored-by: tlmquintino <965734+tlmquintino@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Mar 13, 2026

@copilot please review this pull request and adapt it to the very latest changes and content of the repo.

Merged with the latest origin/main in 2bfcd13. Three changes from main were incorporated:

  1. Development Practices/Observability.md — renamed to development-practices/Observability.md (kebab-case, consistent with the rest of this PR)
  2. languages/python_wheels.md — updated content from PR Docs for python wheels, development update 1 #35 merged cleanly; also fixed a cfiicffi typo in 9dc3746
  3. Root README.md — merge conflict resolved; Observability link now points to the new kebab-case path

@tlmquintino
Copy link
Member

@copilot please bring back the directory names with capitalised first letters and acronyms in full capitals (ADR and ESEE). Keep the corrections and reorganisations.

…ll links

Co-authored-by: tlmquintino <965734+tlmquintino@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Mar 14, 2026

@copilot please bring back the directory names with capitalised first letters and acronyms in full capitals (ADR and ESEE). Keep the corrections and reorganisations.

Done in 10204bb. All 14 directories now use capitalised first letters with acronyms in full capitals:

ADR, ESEE, Containerisation, Testing, Guidelines, Languages, Legal, Contributing Upstream, Development Practices, Documentation and Training, External Contributions, Project Maturity, Repository Structure, Software Management Plan

All corrections and reorganisations are preserved: typo fixes, AI guidelines moved to Guidelines/, Contributing Upstream rename, index READMEs, and the merge of latest main (Observability, python_wheels). All internal links and hardcoded GitHub URLs updated to match the new paths.

Copilot AI changed the title Tidy repository structure: rename directories and reorganise content Tidy repository structure: reorganise content and fix typos Mar 14, 2026
@tlmquintino
Copy link
Member

@copilot please rename pr_guidelines.md to pull-requests.md and maintain it inside the Guidelines directory.

Co-authored-by: tlmquintino <965734+tlmquintino@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Mar 14, 2026

@copilot please rename pr_guidelines.md to pull-requests.md and maintain it inside the Guidelines directory.

Renamed in 381cc9f. Guidelines/pr_guidelines.mdGuidelines/pull-requests.md, and updated the reference in Guidelines/README.md.

@tlmquintino tlmquintino marked this pull request as ready for review March 14, 2026 00:31
@tlmquintino
Copy link
Member

@copilot please move Containerisation/Readme into Guidelines/Containerisation.md. Also move Observability.md into Guidelines and remove the dir 'Development Practices'

… directories

Co-authored-by: tlmquintino <965734+tlmquintino@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Mar 14, 2026

@copilot please move Containerisation/Readme into Guidelines/Containerisation.md. Also move Observability.md into Guidelines and remove the dir 'Development Practices'

Done in 13288b6. Moved Containerisation/README.mdGuidelines/Containerisation.md and Development Practices/Observability.mdGuidelines/Observability.md. Both empty directories removed. Root README.md and Guidelines/README.md links updated.

@tlmquintino
Copy link
Member

@copilot move External Contributions/README to Guidelines/external-contributions.md

…ns.md

Co-authored-by: tlmquintino <965734+tlmquintino@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Mar 14, 2026

@copilot move External Contributions/README to Guidelines/external-contributions.md

Done in 0f045f2. Moved External Contributions/README.mdGuidelines/external-contributions.md, removed the empty directory, and updated links in root README.md, Guidelines/README.md, and Legal/open_sourcing_software.md.

@tlmquintino tlmquintino merged commit 162dfaf into main Mar 14, 2026
@tlmquintino tlmquintino deleted the copilot/tidy-up-repository-structure branch March 14, 2026 00:42
@tlmquintino
Copy link
Member

@copilot please rebase this PR and move the file to be part of the Guidelines directory with the name braching.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants