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 PR Template #38

Merged

Conversation

piyushswain
Copy link
Contributor

This PR adds a new PR template for the repository

@DanielePalombo
Copy link
Collaborator

@piyushswain how is going with this Template? 🤔

@DanielePalombo
Copy link
Collaborator

What do you think to add a section where we can specify the severity of the COP.
ref #49

@piyushswain
Copy link
Contributor Author

What do you think to add a section where we can specify the severity of the COP. ref #49

Yes, we should look at adding a severity level to the PR template.
Will update

@piyushswain piyushswain force-pushed the piyushswain-add-pr-template branch 2 times, most recently from 516d0a3 to 62d1bda Compare August 1, 2023 07:25
Copy link
Collaborator

@MassimilianoLattanzio MassimilianoLattanzio left a comment

Choose a reason for hiding this comment

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

WDYT about adding an intro text to specify to follow this instructions only if we're creating a new cop?

* [ ] Squashed related commits together.
* [ ] Added tests.
* [ ] Ran and ensured all tests are passing on a development environment.
* [ ] If this is a new cop, added an entry for the cop on `/config/default.yml`
Copy link
Collaborator

Choose a reason for hiding this comment

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

Additionally, for almost every PRs, creating the relative changelog entry as mentioned here will be better.

WDYT of adding another action item here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will add another action item here for the changelog

Copy link
Collaborator

Choose a reason for hiding this comment

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

After merging #51, it's better to add another action item about updating the documentation running the bundle exec rake task

The more detailed you are, the better.**

-----------------
Severity:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Screenshot 2023-08-01 at 11 45 18

Is this the intended result? Probably is better to apply the same style as the Before submitting the PR... section

Copy link
Contributor Author

@piyushswain piyushswain Aug 3, 2023

Choose a reason for hiding this comment

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

Hey this is the preview from github's markdown editor
Screenshot 2023-08-03 at 12 30 01 PM

I don't know why the file preview is a bit weird but this one looks fine in the markdown editor

This template should contain all required information we want on a cop PR.
Copy link
Collaborator

@MassimilianoLattanzio MassimilianoLattanzio left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for the updates!

@piyushswain piyushswain merged commit e62c4c3 into solidusio:master Aug 11, 2023
4 checks passed
@piyushswain piyushswain deleted the piyushswain-add-pr-template branch August 11, 2023 05:49
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.

3 participants