Skip to content

Commit 162dfaf

Browse files
authored
Merge pull request #41 from ecmwf/copilot/tidy-up-repository-structure
Tidy repository structure: reorganise content and fix typos
2 parents 0a6974c + 0f045f2 commit 162dfaf

20 files changed

Lines changed: 46 additions & 22 deletions

ADR/ADR-Guidelines.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document provides a Guidelines and a template for creating Architectural De
44

55
## Template for Architectural Decision Records (ADRs)
66

7-
Please find the template for creatinsg ADRs in the [ADR-Template.md](./ADR-Template.md) file. This template should be used for all ADRs to ensure consistency and clarity.
7+
Please find the template for creating ADRs in the [ADR-Template.md](./ADR-Template.md) file. This template should be used for all ADRs to ensure consistency and clarity.
88

99
## Purpose
1010

@@ -22,7 +22,7 @@ Create an ADR when making decisions that:
2222
- **Require justification and analysis** - Trade-offs between options, risk assessments, cost-benefit
2323
- **Involve trade-offs between alternatives** - For example performance vs. maintainability, cost vs. functionality
2424
- **Establish important conventions** - Coding standards, deployment processes, monitoring strategies
25-
- **Address compliance or regulatory requirements** - Adherance to standards like OGC and Data governance, but also security policies and identity managment
25+
- **Address compliance or regulatory requirements** - Adherence to standards like OGC and Data governance, but also security policies and identity management
2626

2727
## Writing Guidelines
2828

@@ -126,10 +126,10 @@ Before finalizing an ADR, ensure it meets these criteria:
126126

127127
## Numbering and Filing
128128

129-
- Use sequential numbering: ADR-001-Meaningfull-Title, ADR-002-Another-Meaningfull-Title, etc.
129+
- Use sequential numbering: ADR-001-Meaningful-Title, ADR-002-Another-Meaningful-Title, etc.
130130
- Store ADRs in the central **Codex** repository under `/ADR/`
131131
- Use descriptive filenames: `ADR-001-Git-Branching-Model.md`
132-
- Use the [ADR index](./ADR/ADR-Index.md) to track all ADRs and their statuses
132+
- Use the [ADR index](./ADR-Index.md) to track all ADRs and their statuses
133133

134134
## Review Process
135135

File renamed without changes.
File renamed without changes.

Documentation and Training/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Documentation
2-
=============
1+
Documentation and Training
2+
==========================
33

44
1. Documentation can be generated via any sensible tool that generates static pages (mkdocs, sphinx, etc.)
55
2. Documentation should be published to readthedocs, github pages or sites.ecmwf.int
File renamed without changes.
File renamed without changes.

Guidelines/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Guidelines
2+
3+
Development guidelines for ECMWF software projects.
4+
5+
## Contents
6+
7+
- [Pull Request Guidelines](./pull-requests.md) — responsibilities for reviewers and reviewees, and the PR workflow
8+
- [AI Contributions to Software](./ai_contributions_to_software.md) — policy guidelines for AI-assisted code generation and AI agents
9+
- [Containerisation](./Containerisation.md) — guidelines for containerising ECMWF software
10+
- [Observability](./Observability.md) — observability guidelines for ECMWF services
11+
- [External Contributions](./external-contributions.md) — guidelines for accepting external contributions to ECMWF projects

Legal/ai_contributions_to_software.md renamed to Guidelines/ai_contributions_to_software.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ At ECMWF, we view AI Code Agents and Large Language Models (LLMs) as powerful pr
3535

3636
### Working with AI Agents
3737

38-
* **Data Privacy and Prompt Security:** Developers must not paste sensitive ECMWF data, proprietary keys, unreleased model architectures, or sensitive infrastructure details into *public* AI prompts (e.g., consumer ChatGPT) versus approved internal enterprise tools like GitHub Copilot Enterprise. We have guarrantees from our enterprise providers that data is kept secure, but we should still avoid sharing sensitive information in prompts.
38+
* **Data Privacy and Prompt Security:** Developers must not paste sensitive ECMWF data, proprietary keys, unreleased model architectures, or sensitive infrastructure details into *public* AI prompts (e.g., consumer ChatGPT) versus approved internal enterprise tools like GitHub Copilot Enterprise. We have guarantees from our enterprise providers that data is kept secure, but we should still avoid sharing sensitive information in prompts.
3939

4040
* **Warning on Intellectual Property and Licensing:** Note that AI models can occasionally reproduce snippets of copyrighted code (e.g., strictly GPL-licensed code). Developers should be reasonably confident the generated code does not violate ECMWF's open-source licensing strategy (mostly Apache 2.0).
4141

File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ merge commits such as "WIP" or "Fix Review Comment", commits like this make it
6767
more difficult in the future to reason about changes. Be aware that this means
6868
rewriting your PRs history. While history rewriting is strongly discourraged
6969
for the primary branches, it is explicitly encouraged on your development
70-
branch to create meaningfull commits.
70+
branch to create meaningful commits.
7171

7272
## General Guidelines
7373

0 commit comments

Comments
 (0)