Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (23 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

31 lines (23 loc) · 2.2 KB
Raw

Contributing

Thanks for taking the time to contribute! This list follows the awesome-lint conventions.

Guidelines

Please ensure your pull request adheres to the following:

  • Search previous PRs or issues before making a new one, to avoid duplicates.
  • One tool per pull request, unless the tools are closely related.
  • New categories should be discussed in an issue first.
  • Add a table row in the correct category — do not create a new category unless nothing existing fits.
  • Table rows must follow the existing format: | # | [Tool](link) | What it helps with | Type | Stage |
  • Use a stage label from the legend: 🟢 Now, 🟡 Evaluate, 🔵 Production, 🟣 Later. Add ⚠️ License check if the tool has a non-permissive or source-available license, dual licensing, or trademark restrictions relevant to resale/white-labeling.
  • Keep the "what it helps with" description under ~12 words, factual, and free of marketing language.
  • Link directly to the tool's official site or primary GitHub repository — not to a reseller, mirror, or SEO aggregator page.
  • Verify the tool is:
    • Actively maintained (commits or releases within the last ~12 months), or a widely-used stable standard.
    • Not a duplicate of an existing entry or a thin wrapper around one already listed.
    • Genuinely relevant to the AI/ML developer delivery path (not general-purpose software with no AI/ML tie-in).
  • If you are affiliated with the tool (maintainer, founder, employee), disclose this in the PR description.
  • Re-number the # column only if inserting into the middle of a table; append new rows at the end of the category if in doubt, and a maintainer will renumber.
  • Run a Markdown linter before submitting — tables must render correctly and links must resolve.

Removing a tool

If a tool is abandoned, unmaintained for a long period, has become closed-source with no viable FOSS alternative in the entry, or has been acquired/discontinued, open an issue or PR explaining why with a link to evidence (archived repo notice, official deprecation announcement, etc.).

Code of conduct

Be respectful. Disagreements about tool inclusion are fine; personal attacks are not.