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.

Sign up for GitHub

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

doc : improved and cleanup of submitting-changes #70208

Merged
merged 2 commits into from
Jan 10, 2020
Merged

doc : improved and cleanup of submitting-changes #70208

merged 2 commits into from
Jan 10, 2020

Conversation

mrVanDalo
Copy link
Contributor

Motivation for this change

Some documentation refactoring

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • 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 nix-review --run "nix-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.
Notify maintainers

I don't know

cc @

@ofborg ofborg bot added the 8.has: documentation This PR adds or changes documentation label Oct 1, 2019
@mrVanDalo mrVanDalo force-pushed the feature/pull-request-workflow branch from 6d9ece5 to 1a685f4 Compare October 1, 2019 21:32
@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux labels Oct 1, 2019
@mrVanDalo mrVanDalo changed the title Feature/pull request workflow doc/submitting-changes : improved and cleanup of section 15 Oct 1, 2019
@mrVanDalo mrVanDalo changed the title doc/submitting-changes : improved and cleanup of section 15 doc : improved and cleanup of submitting-changes Oct 1, 2019
@7c6f434c
Copy link
Member

7c6f434c commented Oct 2, 2019

Related to: NixOS/rfcs#53

7c6f434c
7c6f434c reviewed Oct 2, 2019
View reviewed changes
doc/submitting-changes.xml Outdated
</listitem>
<listitem>
<para>
Notify maintainers of the package. For example add to the message: <command>cc @jagajaga @domenkozar</command>.
Copy link
Member

Choose a reason for hiding this comment

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

If you edit an existing package, ofBorg will notify the maintainers automatically, so maybe drop that?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

not yet. right @Lassulus ?

Copy link
Member

Choose a reason for hiding this comment

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

I think only the maintainer which are part of the organization. I'm not sure if this includes everyone by now?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also the cc part is still in the template. I looked at some pull-requests and it seems that ofBorg adds reviewers, but not all maintainers.

Copy link
Member

Choose a reason for hiding this comment

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

Asked in NixOS/rfcs#39 — it looks like vast majority of maintainers are currently indeed organisation members (via readonly maintainers team) and can be review-requested. If every maintainer has already been invited, we could drop the cc line in template too, I guess.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So I wouldn't do it now. I'll come back to it in another pull-request.

Copy link
Member

Choose a reason for hiding this comment

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

I think NixOS/rfcs#39 has been now implemented as well as it can be…

Copy link
Contributor Author

Choose a reason for hiding this comment

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

removed the line from this pull-request. I don't have the privileges to change the pull-request template. @Mic92 @Lassulus ?

alyssais
alyssais requested changes Oct 2, 2019
View reviewed changes
doc/submitting-changes.xml Outdated Show resolved Hide resolved
@mrVanDalo mrVanDalo force-pushed the feature/pull-request-workflow branch from d30eadb to 5b7ca8c Compare October 2, 2019 13:36
@mrVanDalo
Copy link
Contributor Author

@alyssais all done.

@mrVanDalo mrVanDalo requested a review from alyssais October 2, 2019 13:37
@Lassulus
Copy link
Member

needs rebase

@mrVanDalo mrVanDalo force-pushed the feature/pull-request-workflow branch from 5b7ca8c to 34f0e5e Compare January 1, 2020 01:32
@mrVanDalo
Copy link
Contributor Author

@Lassulus done

@mrVanDalo mrVanDalo force-pushed the feature/pull-request-workflow branch from 34f0e5e to 9d9fa91 Compare January 2, 2020 08:45
@7c6f434c
Copy link
Member

7c6f434c commented Jan 2, 2020 via email

@mrVanDalo mrVanDalo force-pushed the feature/pull-request-workflow branch from 9d9fa91 to d9bbc22 Compare January 3, 2020 02:59
@mrVanDalo
Copy link
Contributor Author

@7c6f434c done

removed the line from this pull-request. I don't have the privileges to change the pull-request template. @Mic92 @Lassulus ?
Well, you can add a change to <nixpkgs>/.github/PULL_REQUEST_TEMPLATE.md to the PR

@Lassulus Lassulus merged commit 773494d into NixOS:master Jan 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Lassulus Lassulus Lassulus left review comments

@7c6f434c 7c6f434c 7c6f434c approved these changes

@alyssais alyssais Awaiting requested review from alyssais

Assignees
No one assigned
Labels
6.topic: policy discussion 8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mrVanDalo @7c6f434c @Lassulus @alyssais