Improve hacking.md and add clangd+bear to devshell #7433
Conversation
yorickvP
requested review from
fricklerhandwerk,
edolstra and
thufschmitt
as code owners
|
|
There was a problem hiding this comment.
Content-wise that's really good, thanks a lot! Left a few suggestions on formatting and wording.
In general, please use lists where there is a list of things, that's much easier to both scan and read. Always link to technical terms and commands, otherwise one has to look them up manually. Not everyone knows every detail of everything, and it gets hairy when the terms are not unique. Then readers won't be sure if they found the right thing.
| This section provides some notes on how to hack on Nix. To get the | ||
| latest version of Nix from GitHub: | ||
|
|
There was a problem hiding this comment.
This sentence and the code snippet that follows it should go above the flakes subsection. Sorry, can't select it properly due to GitHub's broken mobile UI.
Totally agree. |
yorickvP
requested review from
fricklerhandwerk
and removed request for
edolstra and
thufschmitt
yorickvP
force-pushed
the
improv-onboarding
branch
from
b56a478
to
21238fd
Compare
yorickvP
requested review from
thufschmitt
and removed request for
fricklerhandwerk
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/tweag-nix-dev-update-42/24204/1 |
balsoft
force-pushed
the
improv-onboarding
branch
from
3097399
to
de8d912
Compare
|
@fricklerhandwerk I've addressed your comments (sorry I can't mark them as resolved). Would you mind taking another look? |
balsoft
force-pushed
the
improv-onboarding
branch
from
de8d912
to
c3c3f7d
Compare
There was a problem hiding this comment.
Thanks for your patience with my nitpicky attention to detail. I really care about this being easy to maintain, and hope that you see why I made those suggestions, even if they appear like really many. Feel free to argue about them, I'm still trying to figure out a writing style and review procedure that scales for consumers and producers alike.
The contents are great and easy to follow, so all of those comments are about cosmetics – which is still important for smooth reading.
balsoft
force-pushed
the
improv-onboarding
branch
from
0a69394
to
f090892
Compare
|
@fricklerhandwerk addressed your feedback and rebased |
- Refer to current version in readme - Split into flakes and non-flakes section - Change order to move nix-build to the end, since people often start with it in the beginning. - Use proper "Note" syntax - Add notes about editor integration - Move information about target platforms and stdenvs into separate sections Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Co-authored-by: Alexander Bantyev <alexander.bantyev@tweag.io> Co-authored-by: Théophane Hufschmitt <theophane.hufschmitt@tweag.io>
balsoft
force-pushed
the
improv-onboarding
branch
from
f3e9b55
to
f2e4279
Compare
|
Rebased&squashed, added co-author information. |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/tweag-nix-dev-update-44/25546/1 |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/nix-team-report-2022-10-2023-03/27486/1 |
Collaboration with @thufschmitt:
Part of #7357