Skip to content
This repository has been archived by the owner on Aug 16, 2023. It is now read-only.

only ignore self-owned events if the project isn't used by others #104

Open
danisyellis opened this issue Mar 2, 2021 · 0 comments
Open
Labels
Hacktoberfest up-for-grabs This issue is ready to be worked on, and unassigned

Comments

@danisyellis
Copy link
Collaborator

danisyellis commented Mar 2, 2021

So we added an env variable IGNORE_SELFOWNED_EVENTS which ignores an event if the author of the event is also the owner of the repo.
The intention of this is to ignore projects that are just someone's practice project that they're storing on GitHub.

I'd like to add another piece to this feature now:

Some percentage of self-owned repos are not simply practice projects, but instead are living open source projects that other people contribute to and use. Therefore, let's add a check that looks to see if this self-owned repo looks like it's a viable open source project and, if so, include it even though it's self-owned.

Implementation:

  1. When a repo is self-owned, do a call to the GH API for repo info.
  2. Then, calculate a score based on the info. The repo gets one point each for
  • Not a fork of another repo
  • Has a license
  • Watchers > 2
  • Stars > 1
  • Forks > 2
  1. Use the score to decide whether or not to count the contribution - if repoScore is > 3 {count this contribution} We might want to make the number 3 a default that's customizable by the user.
  2. Add documentation to the README about this:
  • explain that self-owned repos aren't counted unless they meet a score threshold
  • explain how the score is calculated (the 5 things that we're checking and the default of 3)
  • include a mention that if someone thinks we're using the wrong numbers or the wrong methodology they can start a GitHub discussion or submit a PR

For Starfish users and potential users: Until this is implemented, feel free to comment here if you have thoughts about how this feature should be implemented.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Hacktoberfest up-for-grabs This issue is ready to be worked on, and unassigned
Projects
None yet
Development

No branches or pull requests

1 participant