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 comment for future developers #46

Closed
wants to merge 5 commits into from

Conversation

cadenmyers13
Copy link
Contributor

No description provided.

Copy link

Warning! No news item is found for this PR. If this is a user-facing change/feature/fix,
please add a news item by copying the format from news/TEMPLATE.rst.

@cadenmyers13
Copy link
Contributor Author

Warning! No news item is found for this PR. If this is a user-facing change/feature/fix, please add a news item by copying the format from news/TEMPLATE.rst.

@sbillinge Would we want to create a news item for this? Thought maybe editing past news file would cause the check to pass lol...

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

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

thanks @cadenmyers13 . We don't want a news for this one because there is already a news for this issue so it will be duplicated in the changelog.

Also, the commit messages are not up to standard and there appears to be multiple commits for a PR that just adds a one line comment.

I will close this. Could you do it over maybe?

Also, I see a comment that says # when. Is this providing the user useful information? I doubt it.

I would love it if we could try and raise our aspirations for code quality and take ownership of our projects, like our children that we want to be proud of. It means loving the code a bit and always trying to think of ways to make it better.

@sbillinge
Copy link
Contributor

Ah, further to my review comments, I see that the edits to the news were editing a previous news to make it better....so kudos for that! Please ignore that part of my comments!

@cadenmyers13
Copy link
Contributor Author

thanks @cadenmyers13 . We don't want a news for this one because there is already a news for this issue so it will be duplicated in the changelog.

Also, the commit messages are not up to standard and there appears to be multiple commits for a PR that just adds a one line comment.

I will close this. Could you do it over maybe?

Also, I see a comment that says # when. Is this providing the user useful information? I doubt it.

I would love it if we could try and raise our aspirations for code quality and take ownership of our projects, like our children that we want to be proud of. It means loving the code a bit and always trying to think of ways to make it better.

Got it! Will do. I made multiple commits because I was dissatisfied with wording (I was being indecisive). I can clean it up and make a new PR tomorrow.

@sbillinge
Copy link
Contributor

In that case multiple commits are ok, but you need to commicate through the commit messages. That is one reason (not the only one) why they are so important. Also, when you write that commit message it helps you think before you commit and you may end up with less indecision....

@sbillinge sbillinge closed this Oct 30, 2024
@cadenmyers13 cadenmyers13 deleted the comment branch October 30, 2024 14:57
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.

2 participants