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

Jump to bottom

nixos/doc: Mention how to contribute to it #101364

Merged
merged 1 commit into from Oct 23, 2020
Merged

nixos/doc: Mention how to contribute to it #101364

merged 1 commit into from Oct 23, 2020

Conversation

doronbehar
Copy link
Contributor

Motivation for this change

A follow up for #98563 (cc @raboof).

Things done

Copied nixpkgs' "how to contribute" file into NixOS' and adjusted it accordingly.

  • 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.

raboof
raboof approved these changes Oct 22, 2020
View reviewed changes
Copy link
Member

@raboof raboof left a comment

Choose a reason for hiding this comment

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

Great to have this in the docs!

@doronbehar
nixos/doc: Mention how to contribute to it
7fb1e3a 
Instead of putting a README in the directory where the manual is
written, put the information from it straight in the docs themselves.
It's a bit untrivial to guess the manual is located exactly there for
contributers.
raboof
raboof approved these changes Oct 22, 2020
View reviewed changes
nixos/doc/manual/README Show resolved Hide resolved
@doronbehar doronbehar merged commit 649a056 into NixOS:master Oct 23, 2020
@doronbehar doronbehar deleted the doc/nixos/manual-contrib branch October 23, 2020 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@raboof raboof raboof approved these changes

Assignees
No one assigned
Labels
6.topic: nixos 8.has: documentation 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 10.rebuild-linux: 1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@doronbehar @raboof