mirror of
https://github.com/wilsonfreitas/awesome-quant.git
synced 2026-08-21 15:58:07 +00:00
docs: clarify commercial eligibility verdicts
This commit is contained in:
@@ -62,8 +62,9 @@ For each added entry, check:
|
|||||||
- Hosted proprietary products without substantive public source belong under
|
- Hosted proprietary products without substantive public source belong under
|
||||||
`Commercial & Proprietary Services`, even when a thin repository exists.
|
`Commercial & Proprietary Services`, even when a thin repository exists.
|
||||||
- For repository-less commercial entries, verify a useful permanent free tier for quantitative
|
- For repository-less commercial entries, verify a useful permanent free tier for quantitative
|
||||||
finance that requires no payment information and is not a trial, demo, or waitlist. Treat a
|
finance that requires no payment information and is not a trial, demo, or waitlist.
|
||||||
hosted service with only a thin repository as repository-less for this check.
|
- Treat a commercial service with only a thin SDK, integration, examples, generated-data, or
|
||||||
|
marketing repository as repository-less for every eligibility check.
|
||||||
- Verify that these commercial entries publish pricing and free-tier limits plus public
|
- Verify that these commercial entries publish pricing and free-tier limits plus public
|
||||||
documentation, methodology, or usage examples; use a stable HTTPS URL without affiliate or
|
documentation, methodology, or usage examples; use a stable HTTPS URL without affiliate or
|
||||||
tracking parameters; and have a concise, factual, non-promotional description.
|
tracking parameters; and have a concise, factual, non-promotional description.
|
||||||
@@ -76,9 +77,10 @@ For each added entry, check:
|
|||||||
|
|
||||||
Apply verdict rules independently to every PR:
|
Apply verdict rules independently to every PR:
|
||||||
|
|
||||||
- `REJECT` paid-only proprietary submissions without substantive public source.
|
- Commercial submissions without a qualifying permanent free tier—including paid-only,
|
||||||
- Use `NEEDS CHANGES` for correctable disclosure, wording, placement, URL, or documentation
|
trial-only, demo-only, and waitlist-only offerings—are `REJECT`.
|
||||||
problems.
|
- Reserve `NEEDS CHANGES` for correctable evidence or disclosure, wording, URL, documentation, or
|
||||||
|
placement defects when the underlying offering can qualify.
|
||||||
|
|
||||||
## Summary Output
|
## Summary Output
|
||||||
|
|
||||||
|
|||||||
@@ -48,8 +48,8 @@ queued or pending attempt supersedes an older successful attempt for the same SH
|
|||||||
CI never replaces inspection of the diff or the manual checks below. A successful check confirms
|
CI never replaces inspection of the diff or the manual checks below. A successful check confirms
|
||||||
only mechanical rules; it does not establish tag meaning or concision, description quality,
|
only mechanical rules; it does not establish tag meaning or concision, description quality,
|
||||||
relevance, semantic section suitability, commercial classification, repository quality,
|
relevance, semantic section suitability, commercial classification, repository quality,
|
||||||
commercial free-tier eligibility or transparency, URL tracking, cross-PR uniqueness, or multi-
|
commercial free-tier eligibility or transparency, URL tracking, cross-PR uniqueness, or
|
||||||
project relatedness. CI cannot establish any of these manual criteria. Search open PRs and PRs
|
multi-project relatedness. CI cannot establish any of these manual criteria. Search open PRs and PRs
|
||||||
closed within the last 365 days for duplicate names and URLs.
|
closed within the last 365 days for duplicate names and URLs.
|
||||||
|
|
||||||
## Validation Checklist
|
## Validation Checklist
|
||||||
@@ -71,8 +71,9 @@ For every added entry:
|
|||||||
- Hosted proprietary products without substantive public source are under
|
- Hosted proprietary products without substantive public source are under
|
||||||
`Commercial & Proprietary Services`, even when a thin repository exists.
|
`Commercial & Proprietary Services`, even when a thin repository exists.
|
||||||
- For repository-less commercial entries, verify a useful permanent free tier for quantitative
|
- For repository-less commercial entries, verify a useful permanent free tier for quantitative
|
||||||
finance that requires no payment information and is not a trial, demo, or waitlist. Treat a
|
finance that requires no payment information and is not a trial, demo, or waitlist.
|
||||||
hosted service with only a thin repository as repository-less for this check.
|
- Treat a commercial service with only a thin SDK, integration, examples, generated-data, or
|
||||||
|
marketing repository as repository-less for every eligibility check.
|
||||||
- Verify that these commercial entries publish pricing and free-tier limits plus public
|
- Verify that these commercial entries publish pricing and free-tier limits plus public
|
||||||
documentation, methodology, or usage examples; use a stable HTTPS URL without affiliate or
|
documentation, methodology, or usage examples; use a stable HTTPS URL without affiliate or
|
||||||
tracking parameters; and have a concise, factual, non-promotional description.
|
tracking parameters; and have a concise, factual, non-promotional description.
|
||||||
@@ -89,10 +90,12 @@ For every added entry:
|
|||||||
Use these verdicts:
|
Use these verdicts:
|
||||||
|
|
||||||
- `APPROVE`: entry is ready to merge.
|
- `APPROVE`: entry is ready to merge.
|
||||||
- `NEEDS CHANGES`: fixable format, disclosure, wording, placement, URL, or documentation issue.
|
- Commercial submissions without a qualifying permanent free tier—including paid-only,
|
||||||
- `REJECT`: paid-only proprietary submission without substantive public source, duplicate,
|
trial-only, demo-only, and waitlist-only offerings—are `REJECT`.
|
||||||
unrelated multi-project PR, empty PR description, archived/abandoned project, or other hard
|
- Reserve `NEEDS CHANGES` for correctable evidence or disclosure, wording, URL, documentation, or
|
||||||
rejection.
|
placement defects when the underlying offering can qualify.
|
||||||
|
- Other `REJECT` cases include duplicates, unrelated multi-project PRs, empty PR descriptions,
|
||||||
|
archived or abandoned projects, and other hard rejections.
|
||||||
|
|
||||||
## Output Shape
|
## Output Shape
|
||||||
|
|
||||||
|
|||||||
@@ -65,13 +65,15 @@ Rules:
|
|||||||
- Descriptions must end with a period before the optional `[GitHub](...)` link.
|
- Descriptions must end with a period before the optional `[GitHub](...)` link.
|
||||||
- URLs in new entries must use `https://`.
|
- URLs in new entries must use `https://`.
|
||||||
- A valid GitHub repository used as the main URL or exact `[GitHub](...)` suffix is preferred
|
- A valid GitHub repository used as the main URL or exact `[GitHub](...)` suffix is preferred
|
||||||
and is a strong positive relevance signal, but it is not universally required. Functional-
|
and is a strong positive relevance signal, but it is not universally required. Functional
|
||||||
section placement requires a repository containing substantive implementation; a thin SDK,
|
section placement requires a repository containing substantive implementation; a thin SDK,
|
||||||
integration, examples, generated-data, or marketing repository does not qualify.
|
integration, examples, generated-data, or marketing repository does not qualify.
|
||||||
- Hosted commercial/proprietary products without substantive public source belong in
|
- Hosted commercial/proprietary products without substantive public source belong in
|
||||||
`## Commercial & Proprietary Services`, even when a thin repository exists. Repository-less
|
`## Commercial & Proprietary Services`, even when a thin repository exists. Repository-less
|
||||||
services qualify only under the permanent free tier and transparency rules in
|
services qualify only under the permanent free tier and transparency rules in
|
||||||
`CONTRIBUTING.md`.
|
`CONTRIBUTING.md`.
|
||||||
|
- Treat a commercial service with only a thin SDK, integration, examples, generated-data, or
|
||||||
|
marketing repository as repository-less for every eligibility check.
|
||||||
- Backtick tags are optional only for commercial services and other metadata-free
|
- Backtick tags are optional only for commercial services and other metadata-free
|
||||||
sections such as `Related Lists`.
|
sections such as `Related Lists`.
|
||||||
- Use `CONTRIBUTING.md` as the user-facing source for contribution rules.
|
- Use `CONTRIBUTING.md` as the user-facing source for contribution rules.
|
||||||
@@ -98,7 +100,11 @@ Review requirements:
|
|||||||
6. Manually assess commercial entries for free-tier usefulness, payment information,
|
6. Manually assess commercial entries for free-tier usefulness, payment information,
|
||||||
public pricing and limits, public documentation/methodology/examples, stable non-tracking
|
public pricing and limits, public documentation/methodology/examples, stable non-tracking
|
||||||
URLs, concise factual description tone, and repository substance.
|
URLs, concise factual description tone, and repository substance.
|
||||||
7. Use the `reviewed` label only after the user approves a review comment.
|
7. Commercial submissions without a qualifying permanent free tier—including paid-only,
|
||||||
|
trial-only, demo-only, and waitlist-only offerings—are `REJECT`. Reserve `NEEDS CHANGES` for
|
||||||
|
correctable evidence or disclosure, wording, URL, documentation, or placement defects when
|
||||||
|
the underlying offering can qualify.
|
||||||
|
8. Use the `reviewed` label only after the user approves a review comment.
|
||||||
|
|
||||||
## GitHub MCP Tools
|
## GitHub MCP Tools
|
||||||
|
|
||||||
|
|||||||
+12
-8
@@ -89,19 +89,23 @@ proprietary project without such a repository qualifies only when it has a meani
|
|||||||
free tier that provides useful quantitative-finance functionality without requiring payment
|
free tier that provides useful quantitative-finance functionality without requiring payment
|
||||||
information. Trials, demos, waitlists, and paid-only products do not qualify.
|
information. Trials, demos, waitlists, and paid-only products do not qualify.
|
||||||
|
|
||||||
Repository-less commercial services must publish pricing and free-tier limits, as well as public
|
Commercial services without substantive public source—including those with only a thin SDK,
|
||||||
documentation, methodology, or usage examples. Their entries must use a stable HTTPS URL without
|
integration, examples, generated-data, or marketing repository—are repository-less for every
|
||||||
affiliate or tracking parameters, have a concise, factual, non-promotional description, and be
|
eligibility check. They must publish pricing and free-tier limits, as well as public documentation,
|
||||||
placed in the **Commercial & Proprietary Services** section. Backtick tags are optional in that
|
methodology, or usage examples. Their entries must use a stable HTTPS URL without affiliate or
|
||||||
section. For example:
|
tracking parameters, have a concise, factual, non-promotional description, and be placed in the
|
||||||
|
**Commercial & Proprietary Services** section. Backtick tags are optional in that section. For
|
||||||
|
example:
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
- [Project Name](https://project.example) - Concise factual description ending with a period.
|
- [Project Name](https://project.example) - Concise factual description ending with a period.
|
||||||
```
|
```
|
||||||
|
|
||||||
A thin SDK, integration, examples, generated-data, or marketing repository does not make the
|
Only a repository containing substantive implementation supports placement in a functional
|
||||||
hosted product open source; only a repository containing substantive implementation supports
|
section. Commercial submissions without a qualifying permanent free tier—including paid-only,
|
||||||
placement in a functional section.
|
trial-only, demo-only, and waitlist-only offerings—are `REJECT`. Reserve `NEEDS CHANGES` for
|
||||||
|
correctable evidence or disclosure, wording, URL, documentation, or placement defects when the
|
||||||
|
underlying offering can qualify.
|
||||||
|
|
||||||
## Section Placement
|
## Section Placement
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user