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

Add pull request template for PlaceCal #2630

Merged

Conversation

lenikadali
Copy link
Collaborator

@lenikadali lenikadali commented Oct 22, 2024

Checklist:

  • I have performed a self-review of my own code,
  • I have commented my code, particularly in hard-to-understand areas,
  • I have made corresponding changes to the documentation,
  • I have added tests that prove my fix is effective or that my feature works,
  • New and existing unit tests pass locally with my changes
  • Title include "WIP" if work is in progress.

Resolves #2501

Description

Motivation and Context

The PR aims to provide a pull request template that makes it easy for new contributors to the project to provide details regarding what their pull request does. It also helps reviewers easily and quickly understand what the pull request is meant to do and review it with the appropriate context in mind.

Type of change

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How Has This Been Tested?

By viewing the resulting markdown file.

How Will This Be Deployed?

N/A

Screenshots

N/A

Added pull request template for PlaceCal
@kimadactyl
Copy link
Member

Hey this is looking great!

There's a bunch of things noted down in the linked ticket - do you think any of them are worth pulling through?

Switched the heading for deployment changes to a checkbox
under the checklist regarding what the effect of the changes
are.

Removed the check for tests since as of now we have test
automation that notifies the committer that their changes
break existing tests.
@lenikadali
Copy link
Collaborator Author

@kimadactyl this should be good to go now. Thanks for the review 🙌🏿

@kimadactyl
Copy link
Member

@kimadactyl this should be good to go now. Thanks for the review 🙌🏿

Did you have a look at the linked ticket and do you think those issues are either represented or not needed?

@lenikadali
Copy link
Collaborator Author

lenikadali commented Oct 23, 2024

@kimadactyl this should be good to go now. Thanks for the review 🙌🏿

Did you have a look at the linked ticket and do you think those issues are either represented or not needed?

I think not needed. The other items could be moved into a separate guide on how to interact with pull requests, both for contributors and reviewers. That's how I've seen it done in other projects. Also can't confirm now but things like console.log statements should be covered out of the box by linters (ESLint, RuboCop etc.)

Edit: also something like changing to view components is ticket specific so that would be added to the ticket for context to whoever ends up working on the feature.

@kimadactyl
Copy link
Member

OK great, happy to merge then :)

@kimadactyl kimadactyl enabled auto-merge October 23, 2024 14:27
@kimadactyl kimadactyl disabled auto-merge October 23, 2024 14:27
@kimadactyl kimadactyl enabled auto-merge (squash) October 23, 2024 14:27
@kimadactyl
Copy link
Member

Ugh #2556 is happening again, so annoying!

@kimadactyl kimadactyl disabled auto-merge October 23, 2024 15:14
@kimadactyl kimadactyl merged commit cdba08e into geeksforsocialchange:main Oct 23, 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.

Add a PR template
2 participants