Skip to content

Conversation

@jmuzina
Copy link
Member

@jmuzina jmuzina commented Nov 26, 2025

Done

I'm leaving the project shortly, so I'm taking the opportunity to clarify some details and best practices that are mostly in my head or have become unspoken practice amongst Vanilla maintainers.

Check if PR is ready for release

If this PR contains Vanilla SCSS or macro code changes, it should contain the following changes to make sure it's ready for the release:

  • PR should have one of the following labels to automatically categorise it in release notes:
    • Feature 🎁, Breaking Change 💣, Bug 🐛, Documentation 📝, Maintenance 🔨.
  • Vanilla version in package.json should be updated relative to the most recent release, following semver convention
    • if existing APIs (CSS classes & macro APIs) are not changed it can be a bugfix release (x.x.X)
    • if existing APIs (CSS classes & macro APIs) are changed/added/removed it should be a minor version (x.X.0)
    • see the wiki for more details
  • Any changes to component class names (new patterns, variants, removed or added features) or macros should be listed on the what's new page.

@jmuzina jmuzina added the Documentation 📝 Documentation changes or updates label Nov 26, 2025
@webteam-app
Copy link

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR enhances project documentation by clarifying best practices, workflows, and conventions for Vanilla Framework maintainers. The documentation consolidates previously undocumented practices into accessible GitHub guides, supporting better onboarding and consistency across the team.

Key Changes

  • Introduced new documentation files for language policy and CI overview
  • Enhanced Percy workflow and hacking guides with additional context about examples, testing, and naming conventions
  • Documented class name prefixes, patterns vs components terminology, and standalone/combined example conventions

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
guides/percy-workflow.md Added cross-reference to hacking guide and tip about appending to combined.html files
guides/language.md New file documenting en-US writing policy and mdspell usage
guides/hacking.md Expanded with sections on examples relationship, combined examples, CI overview, patterns vs components, class prefixes, and language policy; fixed typo "name" → "named"
guides/ci.md New comprehensive guide covering local checks, Percy, Jest, Parker, Cypress, and spelling

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jmuzina jmuzina marked this pull request as ready for review December 1, 2025 14:18
@jmuzina jmuzina requested a review from advl December 1, 2025 14:18
@jmuzina jmuzina changed the title wip: docs: Clarify documentation gaps across the project docs: Clarify documentation gaps across the project Dec 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation 📝 Documentation changes or updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants