Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (35 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

58 lines (35 loc) · 3.05 KB
Raw

Contributing

Corrections are the most valuable thing you can send. Rankings rot — pricing changes, features ship, and a score that was right in Q1 is wrong by Q3.

What we want

Factual corrections. A price changed, a feature shipped, a limit moved, a claim was never true. These get merged fast. Include a link to the vendor page or docs.

Score challenges. Argue that a tool should score differently on a dimension. Open an issue rather than a PR, and make the case against the scoring anchors — "Jira's setup cost is a 2, not a 1, because X" is actionable. "Jira is good actually" is not.

Missing tools. Tell us what's missing and, ideally, why it belongs. Bias is toward tools a real team could plausibly standardize on.

Weight challenges. The weights on each ranking page are the opinionated part. If you think "best project management tools" over-weights setup cost, say so — that's the most interesting argument to have here.

If you work for one of these vendors

You're welcome here. Two conditions:

  1. Say who you work for in the PR or issue body.
  2. Factual corrections only. We'll merge a correction about your product whether or not it improves your standing. We won't merge a rewrite of our analysis into your positioning.

If you think a score is unfair, argue it in an issue where everyone can see the argument.

Standards

Cite sources. Vendor docs, pricing pages, changelogs. Update the Last verified: YYYY-MM-DD line at the top of any file whose facts you touch.

Mark hands-on claims. If it comes from using the tool rather than reading about it, say so inline. Both are legitimate; readers should know which they're getting.

Say when you don't know. A Not verified note is better than a confident guess. Guesses are how comparison content becomes worthless.

Keep competitor coverage straight. State strengths plainly. If a competitor is better at something, the sentence should end there, not pivot into a rebuttal.

Prices are list price, USD, per seat, per month, billed annually unless explicitly stated otherwise. Note the tier.

File conventions

README.md                  Hub, master scorecard, navigation
METHODOLOGY.md             Rubric and scoring anchors
DISCLOSURE.md              Conflict of interest
rankings/*.md              Weighted rankings for a use case
tools/*.md                 Single-tool profiles
comparisons/*.md           Head-to-heads
dimensions/*.md            Cross-tool deep dives on one dimension

Every tools/ and comparisons/ file opens with:

**Last verified:** YYYY-MM-DD · **Hands-on:** production | trialled | evaluated from docs

production means we've run a team on it. trialled means a real but time-boxed evaluation. evaluated from docs means we haven't used it seriously and the profile is documentation-based — score it accordingly.

Review

PRs are reviewed by a Macro team member. Factual corrections typically merge within a few days. Score and weight changes get discussed in the issue first, in public.