Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(SQUASH PLS) Include MAJOR change details in PR template #306

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

vcschapp
Copy link
Collaborator

@vcschapp vcschapp commented Dec 11, 2024

Category

What kind of change is this?

  1. Cosmetic change.
  2. Documentation change by member.
  3. Documentation change by Overture tech writer.
  4. Material change.

Description

Brief description of the business purpose and effect of the pull request.

This change updates the pull request template to align with the schema versioning and stability wiki.

Reference

List of relevant links to GitHub issues, PRs, and other documentation.

Testing

Brief description of the testing done for this change showing why you are confident it works as expected and does not introduce regressions. Provide sample output data where appropriate.

N/A - Not really testable.

Checklist

Checklist of tasks commonly-associated with schema pull requests. Please review the relevant checklists and ensure you do all the tasks that are required for the change you made.

  1. Add relevant examples.
  2. Add relevant counterexamples.
  3. Update any counterexamples that became obsolete. For example, if a counterexample uses property A but is not intended to test property A's validity, and you made a schema change that invalidates property A in that counterexample, fix the counterexample to align it with your schema change.
  4. Update in-schema documentation using plain English written in complete sentences, if an update is required.
  5. Update Docusaurus documentation, if an update is required.
  6. Review change with Overture technical writer to ensure any advanced documentation needs will be taken care of, unless the change is trivial and would not affect the documentation.

Documentation Website

Update the hyperlink below to put the pull request number in.

Docs preview for this PR.

This commit updates the pull request template to align with the
schema versioning and stability wiki.

Reference: https://lf-overturemaps.atlassian.net/wiki/x/GgDa
@vcschapp vcschapp changed the title Pr template major Include MAJOR change details in PR template Dec 11, 2024
@vcschapp vcschapp self-assigned this Dec 11, 2024
@vcschapp vcschapp added the documentation Improvements or additions to documentation label Dec 11, 2024
@vcschapp vcschapp changed the title Include MAJOR change details in PR template (SQUASH PLS) Include MAJOR change details in PR template Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant