forked from lix-project/lix-installer
Fix the contributing documentation for Lix, some
Some. There's still a bunch of stuff that's busted and we need to fix it
up.
Change-Id: Id9fe1fc054616df34045340ec3b02dda723f1d9c
This commit is contained in:
parent
0256e915e7
commit
8d04ca8d3d
|
|
@ -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.
|
and energy trying to improve the tool.
|
||||||
|
|
||||||
In order to ensure we all have a good experience, please review this document
|
In order to ensure we all have a good experience, please review this document
|
||||||
if you have any questions about the process.
|
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
|
contributing to other serious Rust ecosystem projects. You may already know
|
||||||
the process and expectations of you, this document shouldn't contain any
|
the process and expectations of you, this document shouldn't contain any
|
||||||
surprises.
|
surprises.
|
||||||
|
|
@ -16,7 +16,7 @@ surprises.
|
||||||
|
|
||||||
# What kinds of contributions are needed?
|
# 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
|
* Bug reports
|
||||||
* Code improvements
|
* Code improvements
|
||||||
|
|
@ -27,33 +27,29 @@ surprises.
|
||||||
* Graphical/visual asset improvement
|
* Graphical/visual asset improvement
|
||||||
* Kind words or recommendation on your own site, repo, stream, or social media
|
* Kind words or recommendation on your own site, repo, stream, or social media
|
||||||
account
|
account
|
||||||
* Onboarding others to using `nix-installer`
|
* Onboarding others to using `lix-installer`
|
||||||
|
|
||||||
|
|
||||||
# What are the expectations you can have of the maintainers?
|
# What are the expectations you can have of the maintainers?
|
||||||
|
|
||||||
You can expect us to:
|
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
|
* Help diagnose bug reports (for supported platforms using supported
|
||||||
languages)
|
languages)
|
||||||
* Give constructive feedback on pull requests
|
* Give constructive feedback on changes
|
||||||
* Merge pull requests which:
|
* Merge changes which:
|
||||||
+ Have been approved of by at least 1 maintainer
|
+ Have been approved of by at least 1 maintainer
|
||||||
+ Pass all tests
|
+ Pass all tests
|
||||||
+ Have no complex conflicts with in-flight high priority work
|
+ Have no complex conflicts with in-flight high priority work
|
||||||
|
|
||||||
The maintainers of this project use a separate issue tracker for some internal
|
[Lix community standards]: https://lix.systems/community-standards/
|
||||||
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.
|
|
||||||
|
|
||||||
|
|
||||||
# What kind of expectations do the maintainers have from you?
|
# What kind of expectations do the maintainers have from you?
|
||||||
|
|
||||||
We expect you to:
|
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
|
* Make an earnest attempt to follow the contribution process described in this
|
||||||
document
|
document
|
||||||
* Update bug reports with a solution, if you find one before we do
|
* 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:
|
It should contain:
|
||||||
|
|
||||||
1. Your OS (Linux, Mac) and architecture (x86_64, aarch64)
|
1. Your OS (Linux, Mac) and architecture (x86_64, aarch64)
|
||||||
2. Your `nix-installer` version (`/nix/nix-installer --version`)
|
2. Your `lix-installer` version (`/nix/lix-installer --version`)
|
||||||
3. The thing you tried to run (eg `nix-installer`)
|
3. The thing you tried to run (eg `lix-installer`)
|
||||||
4. What happened (the output of the command, please)
|
4. What happened (the output of the command, please)
|
||||||
5. What you expected to happen
|
5. What you expected to happen
|
||||||
6. If you tried to fix it, what did you try?
|
6. If you tried to fix it, what did you try?
|
||||||
|
|
@ -364,6 +360,9 @@ To cut a release:
|
||||||
+ `nix flake check -L`
|
+ `nix flake check -L`
|
||||||
+ `nix build .#hydraJobs.container-test.all.x86_64-linux.all -L -j 6`
|
+ `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`
|
+ `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")
|
* Push the branch, create a PR ("Release v0.0.1")
|
||||||
* Once the PR tests pass and it has been reviewed, merge it
|
* Once the PR tests pass and it has been reviewed, merge it
|
||||||
* `git pull` on the `main` branch
|
* `git pull` on the `main` branch
|
||||||
|
|
|
||||||
|
|
@ -338,13 +338,14 @@ Here are some example `nix` package URLs including nix version, OS and architect
|
||||||
|
|
||||||
## Installation Differences
|
## 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`:
|
* 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
|
+ `bash-prompt-prefix` is set
|
||||||
+ `auto-optimise-store` is set to `true` (On Linux only)
|
+ `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`
|
* `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`
|
* 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
|
* `nix-channel --update` is not run, `~/.nix-channels` is not provisioned
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue