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

pull-request-template: Add the link on tests documentation? #57075

Closed
wants to merge 1 commit into from

Conversation

ardumont
Copy link
Contributor

@ardumont ardumont commented Mar 8, 2019

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,

@ardumont ardumont changed the title pull-request-template: Add the link on tests documentation pull-request-template: Add the link on tests documentation? Mar 8, 2019
@danbst
Copy link
Contributor

danbst commented Mar 9, 2019

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:

  • how to run tests
  • list of tests (non-exhaustive, just to show what can be tested - simple test, simple test with GRUB/UEFI, graphical subsystem, SQL database, network of machines with frontend and backend, declarative containers)
  • how to debug tests interactively
  • and finally, how to write tests

@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

@ardumont
Copy link
Contributor Author

ardumont commented Mar 9, 2019

I think there should be only one link - to tests manual.

I thought so as well but i was not so blunt as to propose the removal of the initial one.
Because there might have been reasons for it...

So do i adapt the commit to drop the first link?

In the tests manual chapters "writing test" and "running tests" should be flipped.

Possibly. I read the full chapter prior to act on it.
But indeed, as the writing tests chapter is quite long.
It could possibly inhibit users from reaching how to run tests.
Then again, there is a toc in the manual so i'm not sure if the flipping is that needed.

list of tests (non-exhaustive, just to show what can be tested - simple test, simple test with GRUB/UEFI, graphical subsystem, SQL database, network of machines with frontend and backend, declarative containers)

That's a good idea ;)

@danbst
Copy link
Contributor

danbst commented Mar 9, 2019

I thought so as well but i was not so blunt as to propose the removal of the initial one.

this section is for newcomers, so newcomer's opinion is valuable here!

So do i adapt the commit to drop the first link?

Yup. Manual has that link in the first line anyway

@stale
Copy link

stale bot commented Jun 2, 2020

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:

  1. Search for maintainers and people that previously touched the related code and @ mention them in a comment.
  2. Ask on the NixOS Discourse.
  3. Ask on the #nixos channel on irc.freenode.net.

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 2, 2020
@stale stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Oct 3, 2020
@ardumont
Copy link
Contributor Author

ardumont commented Nov 1, 2020

I had forgotten about this, updated!

Cheers,

@stale
Copy link

stale bot commented Jun 3, 2021

I marked this as stale due to inactivity. → More info

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 3, 2021
@ardumont
Copy link
Contributor Author

ardumont commented Jun 4, 2021

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.
@stale stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 5, 2021
@stale
Copy link

stale bot commented Jan 9, 2022

I marked this as stale due to inactivity. → More info

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jan 9, 2022
@Artturin
Copy link
Member

Thank your for your pr, a section similar to this Is now in the template

@Artturin Artturin closed this May 17, 2022
@ardumont
Copy link
Contributor Author

Great, thanks for the heads up.

Cheers,

@ardumont ardumont deleted the manual-update branch May 17, 2022 07:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md 6.topic: policy discussion 10.rebuild-darwin: 0 10.rebuild-linux: 0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants