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

Restore accidentally-deleted PR naming conventions #1689

Merged
merged 3 commits into from
Jul 5, 2022
Merged

Conversation

deepyaman
Copy link
Member

@deepyaman deepyaman commented Jul 5, 2022

Signed-off-by: Deepyaman Datta deepyaman.datta@utexas.edu

Description

5ca2fca accidentally dropped the PR naming conventions introduced in a47ca06 (or at least I don't see any justification in https://github.com/quantumblacklabs/private-kedro/pull/1169, having trawled through the comments therein).

Maybe it's just me, but I really do appreciate more standardized commit messages when contributing to and looking through change logs of other open source projects, and I think there is no downside to enforcing some convention. I would also be happy with a stricter convention (e.g. Conventional Commit), but Kedro hasn't followed anything as such so far, and that's OK.

Development notes

Checklist

  • Read the contributing guidelines
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes

Signed-off-by: Deepyaman Datta <deepyaman.datta@utexas.edu>
Signed-off-by: Deepyaman Datta <deepyaman.datta@utexas.edu>
show_locals=True, suppress=[click, str(Path(sys.executable).parent)]
)
rich_pretty_install()
rich.pretty.install()
Copy link
Member Author

Choose a reason for hiding this comment

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

@AntonyMilneQB I piggy-backed a trivial change that I wanted to suggest upon reviewing some of the new rich code. I think it's better to just use the original module path, rather than from ... import ... as ... and basically end up with the same thing, with underscores replacing dots.

Copy link
Contributor

Choose a reason for hiding this comment

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

Very good suggestion, thank you!

@deepyaman deepyaman marked this pull request as ready for review July 5, 2022 02:30
Copy link
Contributor

@antonymilne antonymilne left a comment

Choose a reason for hiding this comment

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

Thank you for putting this back! I'm pretty sure it was removed by accident. I am also a fan of these guidelines 👍

show_locals=True, suppress=[click, str(Path(sys.executable).parent)]
)
rich_pretty_install()
rich.pretty.install()
Copy link
Contributor

Choose a reason for hiding this comment

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

Very good suggestion, thank you!

Copy link
Contributor

@SajidAlamQB SajidAlamQB left a comment

Choose a reason for hiding this comment

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

Thank you! 👍

@deepyaman deepyaman merged commit d2feda2 into main Jul 5, 2022
@deepyaman deepyaman deleted the deepyaman-patch-1 branch July 5, 2022 14:05
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