diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 38f0b07..37b37d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,14 @@ -# Contributing to `nix-installer` +# Contributing to `lix-installer` -We're excited to see what you'd like to contribute to `nix-installer`! +We're excited to see what you'd like to contribute to `lix-installer`! -Regardless of what (or how much) you contribute to `nix-installer`, we value your time +Regardless of what (or how much) you contribute to `lix-installer`, we value your time and energy trying to improve the tool. In order to ensure we all have a good experience, please review this document if you have any questions about the process. -**Regular Rust committer?** Contributing to `nix-installer` should feel similar to +**Regular Rust committer?** Contributing to `lix-installer` should feel similar to contributing to other serious Rust ecosystem projects. You may already know the process and expectations of you, this document shouldn't contain any surprises. @@ -16,7 +16,7 @@ surprises. # What kinds of contributions are needed? -`nix-installer` can benefit from all kinds of contributions: +`lix-installer` can benefit from all kinds of contributions: * Bug reports * Code improvements @@ -27,33 +27,29 @@ surprises. * Graphical/visual asset improvement * Kind words or recommendation on your own site, repo, stream, or social media account -* Onboarding others to using `nix-installer` +* Onboarding others to using `lix-installer` # What are the expectations you can have of the maintainers? You can expect us to: -* Follow the [Contributor Covenant](CODE_OF_CONDUCT.md), just like you +* Follow the [Lix community standards], just like you * Help diagnose bug reports (for supported platforms using supported languages) -* Give constructive feedback on pull requests -* Merge pull requests which: +* Give constructive feedback on changes +* Merge changes which: + Have been approved of by at least 1 maintainer + Pass all tests + Have no complex conflicts with in-flight high priority work -The maintainers of this project use a separate issue tracker for some internal -tasks. Unfortunately, the contents of this tracker is not publicly visible as -it may contain sensitive or confidential data. Our maintainers will endeavor to -ensure you are not 'left out' of the discussion about your contributions. - +[Lix community standards]: https://lix.systems/community-standards/ # What kind of expectations do the maintainers have from you? We expect you to: -* Follow the [Contributor Covenant](CODE_OF_CONDUCT.md), just like them +* Follow the [Lix community standards], just like them * Make an earnest attempt to follow the contribution process described in this document * Update bug reports with a solution, if you find one before we do @@ -74,8 +70,8 @@ Create an issue on [the issue page](https://git.lix.systems/lix-project/lix-inst It should contain: 1. Your OS (Linux, Mac) and architecture (x86_64, aarch64) -2. Your `nix-installer` version (`/nix/nix-installer --version`) -3. The thing you tried to run (eg `nix-installer`) +2. Your `lix-installer` version (`/nix/lix-installer --version`) +3. The thing you tried to run (eg `lix-installer`) 4. What happened (the output of the command, please) 5. What you expected to happen 6. If you tried to fix it, what did you try? @@ -364,6 +360,9 @@ To cut a release: + `nix flake check -L` + `nix build .#hydraJobs.container-test.all.x86_64-linux.all -L -j 6` + `nix build .#hydraJobs.vm-test.all.x86_64-linux.all -L -j 6` + +FIXME: the following is outdated for Lix and needs rewriting: + * Push the branch, create a PR ("Release v0.0.1") * Once the PR tests pass and it has been reviewed, merge it * `git pull` on the `main` branch diff --git a/README.md b/README.md index 6381876..ded6f1e 100644 --- a/README.md +++ b/README.md @@ -338,13 +338,14 @@ Here are some example `nix` package URLs including nix version, OS and architect ## Installation Differences -Differing from the upstream [Nix](https://github.com/NixOS/nix) installer scripts: +Differing from the [CppNix](https://github.com/NixOS/nix) installer scripts: * In `nix.conf`: - + the `nix-command` and `flakes` features are enabled + + the `nix-command` and `flakes` features are optionally enabled + `bash-prompt-prefix` is set + `auto-optimise-store` is set to `true` (On Linux only) - * `extra-nix-path` is set to `nixpkgs=flake:nixpkgs` + * `extra-nix-path` is set to `nixpkgs=flake:nixpkgs` if flakes are enabled + when installing * `max-jobs` is set to `auto` * an installation receipt (for uninstalling) is stored at `/nix/receipt.json` as well as a copy of the install binary at `/nix/lix-installer` * `nix-channel --update` is not run, `~/.nix-channels` is not provisioned