Skip to content

Improve affiliation plugin documentation and useability #1267

Open

Description

@j-lanson

The affiliation plugin is known to often fail when using its default configuration of "flag any authors with email domains not matching Orgs.kdl". For new users of Hipcheck, why these authors were flagged is not well-explained at all, the standard error output saying that they were "affiliated" but not providing any explanation as to what that means. For intermediate Hipcheck users, the documentation around what the Affiliation "strategy" and "mode" means and how to tailor the strategy / config file to their needs is very underdeveloped. In all, this makes the analysis difficult to understand and change, and I expect it will often be ignored or disabled quickly by users.

I recommend the following:

  • Improve the language around the "modes" (Independent, affiliated, etc.) in both the code comments and documentation. In the docs, give toy config examples for achieving different sample config goals (how to use a strategy tree to allow one author but not another).
    • I would also suggest renaming the modes to be more clear, perhaps "independent"/"affiliated" should just be "allow"/"deny".
  • Revise how affiliate analysis is printed in the Hipcheck output to include some description of the strategy/mode config that was used so that new users can interpret the list of flagged authors.

Activity

  1. added theissue type on Jan 27, 2026
  2. alilleybrinker commented on Jan 27, 2026

    @alilleybrinker
    Contributor

    Thanks for the report, Julian! Yeah I agree this all ought to be improved, both the UX and the documentation. Documentation is obviously easier to start with, and things like renaming policy-file options would need to be done as aliases with the old ones supported and deprecated, if we decided to go that way.

  3. alilleybrinker commented on Feb 5, 2026

    @alilleybrinker
    Contributor

    Made some documentation improvements in #1271. Still more to consider, including introducing "allow" and "deny" as alternatives to "independent" and "affiliated", and improving some of the UX around how results are reported in CLI output when this is used as a top-level analysis.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    product: pluginRelates to one or more hipcheck-maintained plugins

    Type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions