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: Ask for docs #27331

Merged
merged 1 commit into from Nov 22, 2018

Conversation

nh2
Copy link
Contributor

@nh2 nh2 commented Jul 12, 2017

Motivation for this change

Based on a discussion in the #nixos IRC channel, we want to put a higher emphasis on docs.

This PR puts Added/updated the necessary docs as the first step into the Things done list.

We want to make clear to contributors that we care about docs.

A later PR should link to specific instructions (probably in CONTRIBUTING.md) that ease beginners into contributing docs to remove any possible barriers.

@mention-bot
Copy link

@nh2, thanks for your PR! By analyzing the history of the files in this pull request, we identified @domenkozar, @vcunat and @edef1c to be potential reviewers.

@@ -3,6 +3,7 @@

###### Things done

- [ ] Added/updated the necessary docs
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd probably say "documentation" here, rather than abbreviating it as "docs". The "docs" abbreviation may not be immediately obvious to non-native English speakers.

@nh2 nh2 force-pushed the ask-for-docs-in-pull-request-template branch from 9f7e59b to db56e06 Compare July 12, 2017 14:11
@FRidh
Copy link
Member

FRidh commented Jul 12, 2017

What should be done before opening a PR is in the contributing guidelines (which refer mostly to the Nixpkgs manual). The PR template contains additional information that can't be seen in the content of the PR. Because whether docs are present or not can easily be seen, I don't think this should be included in the template. Instead, it should go in the contributing guidelines (and thus possibly Nixpkgs manual).

@grahamc
Copy link
Member

grahamc commented Jul 22, 2017

I agree, but having a final-moment-checkbox will be good I think. I've seen people worried they can't tick the macos box b/c they don't have it -- they see the tickmarks as obligations. I'll merge this today if nobody replies.

@FRidh
Copy link
Member

FRidh commented Jul 22, 2017

I agree, but having a final-moment-checkbox will be good I think.

Yes, it can be useful but we cannot have check-boxes for everything. As soon as you start with this, more will follow. See also #27522 (comment).

I've seen people worried they can't tick the macos box b/c they don't have it -- they see the tickmarks as obligations.

Then we should clarify that. But that's irrelevant to this PR.

@FRidh
Copy link
Member

FRidh commented Jul 22, 2017

Then we should clarify that.

I've pushed 138eba0 to clarify what the check-boxes are for.

@FRidh
Copy link
Member

FRidh commented Jul 22, 2017

On second thought I think it can be relevant if stated somewhat differently. Looking at a diff one cannot tell if there is any existing documentation that need to be updated. Therefore, asking whether they

  • Assured whether relevant documentation is up to date.

is useful from a reviewer point of view.

Furthermore, I think a mention about documentation should be made in the manual. There is nothing about documentation in https://nixos.org/nixpkgs/manual/#chap-submitting-changes.

Maybe I'm just nitpicking now ... :)

@samueldr
Copy link
Member

You're not.

I believe you're right that emphasis on amending and writing proper documentation should be added to the submitting changes manual.

That is, anything requiring release notes to add release notes; anything else affecting the truthfulness of existing documentation.

Though, it shouldn't block updating and merging this PR.

Do we think the re-phrased checkbox is fine? The clarification from 138eba0 has meanwhile been removed anew; but the way @FRidh phrased the box makes it checkable even when there's nothing to write.

👍 to either move this forward or close this PR if deemed irrelevant.

@nh2 nh2 force-pushed the ask-for-docs-in-pull-request-template branch from db56e06 to 8f170fa Compare November 22, 2018 17:47
@nh2
Copy link
Contributor Author

nh2 commented Nov 22, 2018

[ ] Assured whether relevant documentation is up to date.

I like this wording. I've updated the PR accordingly.

@FRidh FRidh merged commit f2816e4 into NixOS:master Nov 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants