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

feat: initial commit of PR template #13

Merged
merged 1 commit into from
Sep 4, 2024

Conversation

grahamwhiteuk
Copy link
Contributor

Which issue(s) does this pull-request address?

Closes: #12

Description

This is a first draft of a PR template for the project intended for review/discussion and potential modification prior to being merged. The intention of the template is to guide contributors towards behaviour that is consistent with the project and to do this in as light-a-weight way as possible. The template covers 3 main areas:

  1. A link to an issue - ideally we have atomic PRs so we have 1 issue and 1 resolving PR that should keep changes small and easier to review. The issue serves as the problem description and discussion space for potential solutions. In some circumstances there may not be an issue raised in which case the linked issue above could be replaced with a summary and description of the problem. However, issue raising is preferred.

  2. Description - this is the space for the PR contributor to talk to the maintainers and describes how the PR resolves the linked issue.

  3. Checklist - a tick list of items to prompt the PR contributor to behave according to the project's standards. Any items not ticked serve as a visual clue for the maintainers to think about whether those items are required for this type of PR.

Checklist

  • I have read the contributor guide
  • Linting passes: yarn lint or yarn lint:fix
  • Formatting is applied: yarn format or yarn format:fix
  • Unit tests pass: yarn test:unit
  • E2E tests pass: yarn test:e2e
  • Tests are included
  • Documentation is changed or added
  • Commit messages and PR title follow conventional commits

Note: tests and documentation not required

@Tomas2D Tomas2D self-requested a review September 4, 2024 14:33
Copy link
Contributor

@Tomas2D Tomas2D left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work 🚀

@Tomas2D Tomas2D merged commit 1a7a1c8 into i-am-bee:main Sep 4, 2024
1 check passed
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.

Pull Request template
2 participants