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

jugglinglab: init at 1.2 #87875

Merged
merged 2 commits into from May 16, 2020
Merged

jugglinglab: init at 1.2 #87875

merged 2 commits into from May 16, 2020

Conversation

wnklmnn
Copy link
Contributor

@wnklmnn wnklmnn commented May 15, 2020

Motivation for this change

Adds jugglinglab. A program to visualize different juggling patterns.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • 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 nixpkgs-review --run "nixpkgs-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.

Copy link
Contributor

@milibopp milibopp left a comment

Choose a reason for hiding this comment

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

Hello, there :)

Thanks for taking the time to contribute a package to nixpkgs. I reviewed your PR and found a few small issues, which I added as comments. Here's a summary following the review guide for new packages.

Reviewed points
  • package path fits guidelines
  • package name fits guidelines
  • package version fits guidelines (but not up-to-date)
  • package build on x86_64, NixOS
  • executables tested on x86_64, NixOS
  • meta.description is set and fits guidelines
  • meta.license fits upstream license
  • meta.platforms is set MISSING
  • meta.maintainers is set
  • build time only dependencies are declared in nativeBuildInputs
  • source is fetched using the appropriate function (no, fetchgit used for GitHub repo)
  • phases are respected
  • patches that are remotely available are fetched with fetchpatch (no patches)
Possible improvements

see code comments

stdenv.mkDerivation rec {
major= "1";
minor = "2";
version = "${major}.${minor}";
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like the most recent version is 1.2.1 and the program gives me a pop-up saying that there is an update. So I would suggest an update ;)

Minor nit-pick: since you are not really using major/minor version info for anything other than the version, I would collapse this down to version = "1.2.1", as it makes the code easier to follow.

@@ -7204,6 +7204,8 @@ in

umlet = callPackage ../tools/misc/umlet { };

jugglinglab = callPackage ../tools/misc/jugglinglab { };
Copy link
Contributor

Choose a reason for hiding this comment

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

For consistency, please sort this alphabetically.

minor = "2";
version = "${major}.${minor}";
name = "jugglinglab";
src = fetchgit {
Copy link
Contributor

Choose a reason for hiding this comment

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

We prefer fetchFromGitHub over fetchgit for GitHub repositories.

meta = with stdenv.lib; {
description = "A program to visualize different juggling pattens";
license = licenses.gpl2;
maintainers = with maintainers; [ wnklmnn ];

This comment was marked as resolved.

Copy link
Contributor

@milibopp milibopp left a comment

Choose a reason for hiding this comment

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

Reviewed points
  • package path fits guidelines
  • package name fits guidelines
  • package version fits guidelines
  • package build on NixOS x86_64
  • executables tested on NixOS x86_64
  • meta.description is set and fits guidelines
  • meta.license fits upstream license
  • meta.platforms is set
  • meta.maintainers is set
  • build time only dependencies are declared in nativeBuildInputs
  • source is fetched using the appropriate function
  • phases are respected
  • patches that are remotely available are fetched with fetchpatch (none)
Possible improvements

none

Comments

👍 looks good to me!

@cdepillabout
Copy link
Member

LGTM

@wnklmnn Thanks for sending this PR, and we look forward to more contributions from you in the future!

@aepsil0n Thanks for doing a quick review of this.

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

4 participants