Skip to content

Conversation

Copy link

Copilot AI commented Jul 14, 2025

Contributors have been using British spelling in code and documentation, but the TypeScript project uses American English consistently. This PR adds a comprehensive "Spelling Guidelines" section to CONTRIBUTING.md to help contributors maintain consistency.

Changes Made

  • Added new "Spelling Guidelines" section after the "Using local builds" section
  • Included comprehensive table of common British vs American spelling differences relevant to programming
  • Provided TypeScript code examples showing correct and incorrect usage
  • Added context-specific examples like backgroundColor, initializeComponent, etc.
  • Positioned the section appropriately within the contribution guidelines flow

Examples from the Guidelines

British American Examples in Context
behaviour behavior defaultBehavior, behaviorSubject
initialise initialize initializeComponent, initializeState
analyse analyze analyzeCode, dataAnalysis

The section includes practical TypeScript code examples:

// ✅ Correct (American spelling)
interface ComponentBehavior {
    initialize(): void;
    analyze(data: unknown): void;
    synchronizeState(): void;
}

// ❌ Incorrect (British spelling)
interface ComponentBehaviour {
    initialise(): void;
    analyse(data: unknown): void;
    synchroniseState(): void;
}

This will help ensure consistency across all contributions to the TypeScript project.

Fixes #18.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI changed the title [WIP] Update CONTRIBUTING.md to include spelling suggestions Add spelling guidelines to CONTRIBUTING.md for American English consistency Jul 14, 2025
Copilot AI requested a review from RyanCavanaugh July 14, 2025 21:15
Copilot finished work on behalf of RyanCavanaugh July 14, 2025 21:15
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.

Update CONTRIBUTING.md to include spelling suggestions

2 participants