Skip to content

Conversation

@pheobeayo
Copy link

Use the following template to create your pull request

Description

docs: document PR Merge Process

  1. Motivation for change: The PR Merge Process needs to prevent PR's from merging that break things.
  2. What was changed: Added the PR Merge Process documentation
  3. How does this impact application developers: This prevents breakages and easier contributions
  4. Link to relevant issues and documentation: This closes document PR merge process #10
  5. Provide examples of use cases with code samples and applicable acceptance criteria

Type of Change

  • New feature
  • Bug fix
    [x] API reference/documentation update
  • Other

Does this introduce a breaking change?

List the APIs or describe the functionality that this PR breaks.
Workarounds for or expected timeline for deprecation

Are documentation updates required?

  • Link to documentation updates:

Testing information

Provide context on how tests should be performed.

  1. Is testing required for this change?
  2. If it’s a bug fix, list steps to reproduce the bug
  3. Briefly mention affected code paths
  4. List other affected projects if possible
  5. Things to watch out for when testing

Checklist

  • Code is commented where needed
  • Unit test coverage for new or modified code paths
  • npm run test passes
  • Changelog is updated
  • Tag 1 of @wileyj

@CLAassistant
Copy link

CLAassistant commented Nov 3, 2025

CLA assistant check
All committers have signed the CLA.

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.

document PR merge process

2 participants