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

doc/setup-doc #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc/setup-doc #2

wants to merge 1 commit into from

Conversation

bplessis-swi
Copy link
Owner

Merge Commit Summary

[PLTFRS-XXX] Short Description of the Change

Detailed description:

  1. [Main point]
  2. [Secondary point]

Pull Request Description

Jira Ticket Link

PLTFRS-XXX

Summary of Changes

  • Feature implementation
  • Bug fix
  • Documentation updates
  • Other: [Specify]

Detailed Description

  1. [Description of specific changes]
  2. [Mention files or modules affected]
  3. [Explain rationale for changes / How does this change address the issue]

Learning

Describe the research stage

Links to blog posts, patterns, libraries or addons used to solve this problem

Testing Instructions

  1. [Step-by-step testing instructions]
  2. [Expected outcomes]

Impact Analysis

  • Requires database migrations
  • Changes the API contract
  • Affects backward compatibility
  • Other: [Specify]

Checklist

  • All new and existing tests pass
  • Documentation has been updated (if necessary)
  • PR title follows the naming convention: JiraTicket Short Summary
  • The associated issue(s) are linked above.
  • PR resolves the associated Jira ticket
  • This PR meets all acceptance criteria for those issues.
  • This PR and linked issue(s) are adequately documented
  • This PR and linked issues(s) are a complete description of the changeset; an individual or team should be able to understand the issue(s) and changes by reading through this PR and it's links, with no further interaction.
  • Someone has been assigned this PR.
  • At least one person has been marked as reviewer on this PR.

Review Notes

Areas for Reviewers to Focus On

Open Questions / Follow-ups


Additional Context

List any other information that you think is important... a post-merge activity, someone to notify, etc.


Localization

Localization Considerations:

Ensure any user-facing text adheres to localization requirements.

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.

1 participant