-
-
Notifications
You must be signed in to change notification settings - Fork 15.5k
pull-request-template: Add the link on tests documentation? #57075
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
Conversation
I think there should be only one link - to tests manual. In the tests manual chapters "writing test" and "running tests" should be flipped. So the order is like this:
@ardumont what do you think, would that order of sections be helpful? This reordering can be done in https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/development/nixos-tests.xml and https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/development/development.xml |
I thought so as well but i was not so blunt as to propose the removal of the initial one. So do i adapt the commit to drop the first link?
Possibly. I read the full chapter prior to act on it.
That's a good idea ;) |
this section is for newcomers, so newcomer's opinion is valuable here!
Yup. Manual has that link in the first line anyway |
Thank you for your contributions. This has been automatically marked as stale because it has had no activity for 180 days. If this is still important to you, we ask that you leave a comment below. Your comment can be as simple as "still important to me". This lets people see that at least one person still cares about this. Someone will have to do this at most twice a year if there is no other activity. Here are suggestions that might help resolve this more quickly:
|
9e504a3
to
f5e0fda
Compare
I had forgotten about this, updated! Cheers, |
I marked this as stale due to inactivity. → More info |
ping? |
Prior to this commit, this referred to nixos/tests tree. This somehow assumes people know how to run tests which is not always true.
I marked this as stale due to inactivity. → More info |
Thank your for your pr, a section similar to this Is now in the template |
Great, thanks for the heads up. Cheers, |
Motivation for this change
When i recently opened a PR [1], i realized i missed test thanks to this guide.
But reading the arborescence tests tree link from this guide overwhelmed me.
I was able somehow to replicate a test but did not know how to run it.
That's clearly well explained in the doc (which somehow i did not find myself...T.T) [2]
So why not link it from the guide for people willing to dig in?
[1] #57036
[2] thanks gchristensen and clever for the help on #nixos
Cheers,