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

Small fixes #16

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

maxkurze1
Copy link

No description provided.

@spacefrogg
Copy link
Collaborator

What does this PR do?

@maxkurze1
Copy link
Author

maxkurze1 commented Dec 9, 2024

It basically collects all the small fixes that don't deserve their own PR (IMO).

As you can see in the commits, this can include: fixing small to-dos, adding trailing semicolons, clean up small unnecessary+unused functions, ...

So this PR is basically intended to stay open and collect all these small adjustments.

Would you prefer to split these fixes into seperate commits/PRs?

@spacefrogg
Copy link
Collaborator

Yes, just split them by scope/topic. And I merge them. Also don't hesitate to describe your changes in the commit messages. ;)

@maxkurze1
Copy link
Author

I am still feeling a bit insecure about how to split it - do you want different PR's ? or only seperate commits?

I don't feel very well building commits with single line changes.

@spacefrogg
Copy link
Collaborator

spacefrogg commented Dec 12, 2024

Yeah, please just split them by concern. If you fulfill a concern with a single-line change, then that is a valid commit and PR. One concern, one PR. You may split a PR into multiple commits if they are functionally distinct. Example: The concern could be "revamp action interface". The different commits could be "revamp untyped actions", "revamp typed actions", ...

Neither PRs nor commits cost any money. Just make new ones. But you only have about 75 characters to motivate your commit. If you put too many unrelated changes into a single commit., nobody will understand why a particular change happened there in the long run, because the commit summary likely won't tell them.

@spacefrogg
Copy link
Collaborator

To lighten your workload. You could just further describe, what changes you did in the 3 commits of this PR, by extending their commit messages. For instance, I have no idea what the "style" fixes actually do functionally. Additionally, please make sure that a commit with the summary "style fixes" actually does not change any semantics. Not even slightly. Nobody suspects that in a commit with that summary. So this would be a clear differentiator to split the commit further.

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