Skip to content

Suggested automation improvements for contributor experience #1421

@salemaljebaly

Description

@salemaljebaly

Following up on #1418 — here are some broader automation ideas that could improve consistency across the repo. Sharing as suggestions for discussion, not necessarily all actionable at once.

1. Local validation script
A simple validate.sh (or npm script) that runs the same ajv-cli check locally, so contributors can catch metadata errors before pushing. The schema and script already exist in .github/scripts-metadata/ — it's mostly a matter of documenting and exposing them.

2. .editorconfig
A minimal .editorconfig (UTF-8, LF line endings, 2-space indent) would reduce whitespace noise in PRs across different editors.

3. Markdown linting
A markdownlint config could catch common formatting mistakes (heading hierarchy, trailing spaces, bare URLs). Could be opt-in at first (warn only) to avoid breaking existing tutorials.

These are suggestions — happy to hear if any are worth pursuing or if there are reasons they've been avoided so far.

@svenja11 tagging you here as well since this is related to #1418.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions