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

castget: init at 1_2_4 #65492

Merged
merged 6 commits into from Aug 20, 2019
Merged

castget: init at 1_2_4 #65492

merged 6 commits into from Aug 20, 2019

Conversation

doronbehar
Copy link
Contributor

Motivation for this change
Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nix-review --run "nix-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@doronbehar
Copy link
Contributor Author

Bump.

@nixos-discourse
Copy link

This pull request has been mentioned on Nix community. There might be relevant details there:

https://discourse.nixos.org/t/prs-ready-for-review-may-2019/3032/42

@doronbehar
Copy link
Contributor Author

Good bot.

@nixos-discourse
Copy link

This pull request has been mentioned on Nix community. There might be relevant details there:

https://discourse.nixos.org/t/join-the-package-maintainer-team/3751/5

Copy link
Member

@timokau timokau left a comment

Choose a reason for hiding this comment

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

LGTM, will merge when ofBorg approves. Thank you!

@doronbehar
Copy link
Contributor Author

Thank you! As a general question, I was wondering, is it usually desired by maintainers that packages related PRs will consist of a single commit? @worldofpeace has asked me in the past to squash changes and since then I've always made changes with a git commit --amend --no-edit and pushed with --force.

@timokau timokau merged commit 5d3b545 into NixOS:master Aug 20, 2019
@doronbehar doronbehar mentioned this pull request Aug 20, 2019
10 tasks
@timokau
Copy link
Member

timokau commented Aug 20, 2019

It depends on context (but also a lot on the reviewer's preferences). My opinion is that every commit should do one thing, but there is no reason to maintain all histories within a PR. So in this case, the "one thing" is initializing a package. Nobody gains any information from the additional commits incorporating my nitpicks (and they don't have the appropriate naming scheme anyway), so I've used github's squash-and-merge feature.

But if, for example, this was the first package you maintain you should have one commit adding yourself to the maintainers list and then a separate commit init'ing the package (using the maintainers entry). Or if you're fixing a broken package and while you're at it also updating it to the latest version, you could have two commits: package: fix build and package: old_version -> new_version.

Basically two rules of thumb:

  • you shouldn't need to use the word "and" in the commit message
  • ask yourself if it could ever be useful to have these as separate commits (for example I might want to revert the init of a package, but that shouldn't revert the addition to the maintainers list as well)

And remember that these are rules of thumb and if its easier to just do everything in one commit, sometimes its just not worth to spend the time and dis-entangle everything ;)

@doronbehar doronbehar deleted the package-castget branch August 22, 2019 06:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants