Hacktoberfest / hacktoberfest-2020

Hacktoberfest - App to manage the annual open-source challenge, used for the 2019 & 2020 seasons.

Home Page:https://hacktoberfest.digitalocean.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Unclear wording around ineligible repositories

boardfish opened this issue · comments

Describe the bug
In the legend on the profile page, it's not explicitly stated whether merged PRs to repositories that haven't opted into Hacktoberfest count towards the quota.

Your PR was submitted to a repository that is not participating in Hacktoberfest. Maintainers of the repository can add the "hacktoberfest" topic to their repository if they wish to participate. Alternatively, an individual PR can be opted-in with a maintainer adding the "hacktoberfest-accepted" label to the PR.

I don't think it helps that the icon is different from Invalid PRs either, but I'm not sure how to address that.

Expected behavior
If PRs to repositories that haven't opted in do not count when they are merged without the hacktoberfest-accepted label, I'd suggest the following copy:

Your PR was submitted to a repository that is not participating in Hacktoberfest. Your PR won't count towards winning Hacktoberfest.
Maintainers of the repository...

As I'm writing this issue, I'm leaning towards this being the case, but the intent doesn't feel too explicit in the current copy.

If PRs to repositories that haven't opted in do count regardless of whether the label is applied, I'd suggest the following copy:

Your PR was submitted to a repository that is not participating in Hacktoberfest. However, your PR will count towards winning Hacktoberfest if it is merged.


I'm happy to take on this change if it makes sense to folks.

👋 I'm not really sure what the intent is here with the new suggested copy -- the current copy seems to me to correctly convey the rules for PRs that qualify:

PRs count if:
Submitted during the month of October AND
Submitted in a public repo AND (
  The PR is labelled as hacktoberfest-accepted by a maintainer OR
  Submitted in a repo with the hacktoberfest topic AND (
    The PR is merged OR
    The PR has been approved
  )
) 

Any PR (merged, open, closed) can be "accepted" by adding the hacktoberfest-accepted label to it, so the Alternatively, an individual PR can be opted-in with a maintainer adding the "hacktoberfest-accepted" label to the PR. copy conveys this correctly, there is no requirement to merge etc.

The alternative is that the repository must have the hacktoberfest topic applied, with the PR then being merged or approved. The copy correctly conveys the requirement for the topic: Maintainers of the repository can add the "hacktoberfest" topic to their repository if they wish to participate.

This copy does not convey the requirement for the PR to be merged/approved, as once the repository has the topic applied an unmerged PR will transition to the pending state, where the copy for that state clearly conveys the requirement: Your PR has not yet been accepted by a maintainer. A maintainer can accept your PR by merging it, adding the "hacktoberfest-accepted" label to it, or approving it. .