Skip to content

docs(contributing): add CONTRIBUTING.md and link from README#240

Merged
michaeljymsgutierrez merged 3 commits into
developfrom
docs/add-contributing-guide
Jun 28, 2026
Merged

docs(contributing): add CONTRIBUTING.md and link from README#240
michaeljymsgutierrez merged 3 commits into
developfrom
docs/add-contributing-guide

Conversation

@michaeljymsgutierrez

Copy link
Copy Markdown
Owner

Description

Adds a CONTRIBUTING.md guide to the repository root and links it from README.md. This gives contributors a clear reference for dev setup, branch naming, commit message conventions, testing requirements, and the PR process.

Github Issue: N/A

Changes

  • CONTRIBUTING.md - new contributor guide covering dev setup, branch naming convention, commit message convention, development workflow, testing, PR process, and code standards
  • README.md - added Contributing entry to Table of Contents and a ## Contributing section at the bottom linking to CONTRIBUTING.md

Screenshots/Images

N/A

How Has This Been Tested?

  • Manual testing: Reviewed the rendered markdown for correctness and verified all links are valid.

Checklist

  • Code follows the project's coding standards and best practices.
  • Existing tests pass.
  • Documentation is updated to reflect changes.
  • The PR is assigned to the correct reviewers.

Reviewer Guidance

  • Open CONTRIBUTING.md and verify all sections are accurate and complete
  • Open README.md and verify the Contributing link in the Table of Contents and the ## Contributing section at the bottom both resolve correctly

@michaeljymsgutierrez michaeljymsgutierrez self-assigned this Jun 28, 2026
@vercel

vercel Bot commented Jun 28, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
arm-js-library-demo Ready Ready Preview, Comment Jun 28, 2026 6:05pm

@michaeljymsgutierrez michaeljymsgutierrez added the docs Documentation additions or improvements label Jun 28, 2026
@michaeljymsgutierrez michaeljymsgutierrez merged commit 9e02459 into develop Jun 28, 2026
3 checks passed
@michaeljymsgutierrez michaeljymsgutierrez deleted the docs/add-contributing-guide branch June 28, 2026 18:07
michaeljymsgutierrez added a commit that referenced this pull request Jun 30, 2026
- [c099dd9][michaeljymsgutierrez]: Updated release version from v2.9.0 to v2.9.1 - 2026-07-01 02:27:36
- [9ca0c99][Chael Gutierrez]: fix(deploy): rename release branch prefix to releases to avoid ref collision (#245) - 2026-07-01 02:26:00
- [f823754][Chael Gutierrez]: chore(deps): fix dependabot security alerts - upgrade vite, vitest, form-data and markdown-it (#244) - 2026-07-01 01:55:56
- [2fcec47][Chael Gutierrez]: chore(deploy): add pre-flight checks, dry-run mode, canary sync, path safety and fail-fast (#243) - 2026-07-01 01:36:47
- [8cf2be1][Chael Gutierrez]: test(units): improve test structure and expand coverage across all unit modules (#242) - 2026-07-01 00:38:33
- [81e929f][Chael Gutierrez]: docs(contributing): add branch purposes, flow diagram, and toc updates (#241) - 2026-06-29 02:27:20
- [9e02459][Chael Gutierrez]: docs(contributing): add CONTRIBUTING.md and link from README (#240) - 2026-06-29 02:07:47
- [b8e9297][Chael Gutierrez]: chore(deps): upgrade production dependencies (#239) - 2026-06-24 02:57:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation additions or improvements

Projects

Development

Successfully merging this pull request may close these issues.

1 participant