Skip to content

Update CONTRIBUTING.md#5762

Merged
compulim merged 10 commits intomainfrom
doc-contributing
Mar 3, 2026
Merged

Update CONTRIBUTING.md#5762
compulim merged 10 commits intomainfrom
doc-contributing

Conversation

@compulim
Copy link
Contributor

@compulim compulim commented Mar 2, 2026

Changelog Entry

(No changelog entry for documentation.)

Description

Updating our (very) outdated CONTRIBUTING.md.

Design

Specific Changes

  • Rename old CONTRIBUTING.md to CONTRIBUTING.old.md
  • Add a new CONTRIBUTING.md
  • I have added tests and executed them locally
  • I have updated CHANGELOG.md
  • I have updated documentation

Review Checklist

This section is for contributors to review your work.

  • Accessibility reviewed (tab order, content readability, alt text, color contrast)
  • Browser and platform compatibilities reviewed
  • CSS styles reviewed (minimal rules, no z-index)
  • Documents reviewed (docs, samples, live demo)
  • Internationalization reviewed (strings, unit formatting)
  • package.json and package-lock.json reviewed
  • Security reviewed (no data URIs, check for nonce leak)
  • Tests reviewed (coverage, legitimacy)

@compulim compulim marked this pull request as ready for review March 2, 2026 22:19
@OEvgeny OEvgeny requested a review from Copilot March 2, 2026 22:27
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 refreshes the repository’s contributor documentation by archiving the prior contribution guide and introducing a new, shorter CONTRIBUTING.md focused on the current development workflow (Codespaces + html2 test harness).

Changes:

  • Added an archived copy of the previous guide as .github/CONTRIBUTING.old.md with a pointer to the new document.
  • Rewrote .github/CONTRIBUTING.md to emphasize Codespaces-based development, the local test browser workflow, and VRT guidance.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 11 comments.

File Description
.github/CONTRIBUTING.old.md Adds the previous contribution guide as an archived reference with a deprecation notice.
.github/CONTRIBUTING.md Replaces the old guide with updated contributor instructions oriented around Codespaces and __tests__/html2.

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

compulim and others added 2 commits March 2, 2026 14:34
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
compulim and others added 3 commits March 2, 2026 14:35
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

Copilot AI commented Mar 2, 2026

@compulim I've opened a new pull request, #5764, to work on those changes. Once the pull request is ready, I'll request review from you.

@compulim compulim merged commit f9d0970 into main Mar 3, 2026
30 checks passed
@compulim compulim deleted the doc-contributing branch March 3, 2026 00:33
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.

4 participants