Skip to content

Commit 7a8d836

Browse files
author
Shaerif
committed
docs: add CONTRIBUTING.md, issue templates; remove UPDATE_RULES ref and empty FUNDING.yml
- Remove docs/UPDATE_RULES.md reference from README header - Create CONTRIBUTING.md with contribution guidelines - Add issue templates: New Model/Tool Request, Update Request, Error Report - Remove empty .github/FUNDING.yml placeholder
1 parent 9c9fd18 commit 7a8d836

6 files changed

Lines changed: 182 additions & 18 deletions

File tree

‎.github/FUNDING.yml‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/error-report.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: "Error Report"
2+
description: "Report incorrect data, broken links, or formatting issues."
3+
title: "[Error]: "
4+
labels: ["bug"]
5+
body:
6+
- type: dropdown
7+
id: type
8+
attributes:
9+
label: Error Type
10+
options:
11+
- Incorrect data (wrong price, score, date, etc.)
12+
- Broken or dead link
13+
- Formatting / display issue
14+
- Duplicate entry
15+
- Other
16+
validations:
17+
required: true
18+
- type: input
19+
id: section
20+
attributes:
21+
label: Section
22+
description: Which section of the README contains the error.
23+
placeholder: e.g. Frontier Models table
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: description
28+
attributes:
29+
label: Description
30+
description: Describe the error and what the correct information should be.
31+
validations:
32+
required: true
33+
- type: input
34+
id: source
35+
attributes:
36+
label: Source URL (if applicable)
37+
description: Link confirming the correct information.
38+
placeholder: https://
39+
validations:
40+
required: false

‎.github/ISSUE_TEMPLATE/new-model-tool.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: "New Model / Tool Request"
2+
description: "Suggest a new AI model, tool, or service to add to the matrix."
3+
title: "[New]: "
4+
labels: ["new-entry"]
5+
body:
6+
- type: input
7+
id: name
8+
attributes:
9+
label: Name
10+
description: Official product name.
11+
placeholder: e.g. Claude Opus 4.6
12+
validations:
13+
required: true
14+
- type: input
15+
id: developer
16+
attributes:
17+
label: Developer / Company
18+
placeholder: e.g. Anthropic
19+
validations:
20+
required: true
21+
- type: dropdown
22+
id: category
23+
attributes:
24+
label: Category
25+
options:
26+
- Frontier Model
27+
- Open-Source Model
28+
- Coding Model
29+
- Reasoning Model
30+
- Multimodal Model
31+
- IDE / Editor
32+
- CLI Tool
33+
- IDE Add-on
34+
- API Provider
35+
- Browser Automation
36+
- Agent Platform
37+
- Desktop Automation
38+
- Other
39+
validations:
40+
required: true
41+
- type: input
42+
id: source
43+
attributes:
44+
label: Official Source URL
45+
description: Link to the official documentation, announcement, or pricing page.
46+
placeholder: https://
47+
validations:
48+
required: true
49+
- type: textarea
50+
id: details
51+
attributes:
52+
label: Details
53+
description: Key features, pricing, context window, benchmarks, or other relevant info.
54+
placeholder: |
55+
- Pricing: $X / $Y per 1M tokens
56+
- Context: 128K
57+
- Key features: ...
58+
validations:
59+
required: false

‎.github/ISSUE_TEMPLATE/update-request.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: "Update Request"
2+
description: "Request an update to an existing entry (pricing change, new version, etc.)."
3+
title: "[Update]: "
4+
labels: ["update"]
5+
body:
6+
- type: input
7+
id: entry
8+
attributes:
9+
label: Entry to Update
10+
description: Name of the model or tool that needs updating.
11+
placeholder: e.g. GPT-5.4
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: current
16+
attributes:
17+
label: Current Information
18+
description: What the entry currently says.
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: updated
23+
attributes:
24+
label: Correct / Updated Information
25+
description: What it should say instead.
26+
validations:
27+
required: true
28+
- type: input
29+
id: source
30+
attributes:
31+
label: Source URL
32+
description: Official link confirming the update.
33+
placeholder: https://
34+
validations:
35+
required: true

‎CONTRIBUTING.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing to AI Models Matrix
2+
3+
Thank you for your interest in contributing. This guide explains how to propose changes, report issues, and keep the list accurate.
4+
5+
## How to Contribute
6+
7+
### Suggesting a New Model or Tool
8+
9+
1. Open an issue using the **New Model / Tool Request** template.
10+
2. Include: name, developer, official source URL, pricing, and key features.
11+
3. Only suggest items you can back with an official or primary source.
12+
13+
### Reporting an Error or Outdated Entry
14+
15+
1. Open an issue using the **Error Report** template.
16+
2. Include: the incorrect entry, what is wrong, and a link to the correct source.
17+
18+
### Submitting a Pull Request
19+
20+
1. Fork the repository and create a branch from `main`.
21+
2. Make your changes in `docs/readme.md`.
22+
3. Follow the existing table format and column structure for the section you are editing.
23+
4. Every factual claim must link to an official or primary source.
24+
5. Keep entries concise — one line per item, no marketing language.
25+
6. Submit your pull request with a clear title describing the change.
26+
27+
## Content Guidelines
28+
29+
- **Primary sources only.** Link to official documentation, release announcements, or pricing pages — not blog summaries or aggregators.
30+
- **No unmaintained or deprecated items.** If a project has been archived or abandoned, do not add it.
31+
- **Consistent naming.** Use the official product name exactly as the developer writes it (e.g., `Claude Opus 4.6`, not `claude-opus-4.6`).
32+
- **Pricing in USD per 1M tokens** for API models, or monthly subscription cost where applicable.
33+
- **Benchmark scores** should reference the specific benchmark version and date.
34+
35+
## Style
36+
37+
- Use `**bold**` for model/tool names in table cells.
38+
- End descriptions with a period.
39+
- Keep table rows aligned and readable.
40+
- Do not add badges or CI status indicators to the README.
41+
42+
## Code of Conduct
43+
44+
Be respectful and constructive. Contributions that include spam, self-promotion without relevance, or hostile language will be closed.
45+
46+
## Questions?
47+
48+
Open a [Discussion](https://github.com/ReadyPixels/AI_Models_Matrix/discussions) or file an issue.

‎docs/readme.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
99
Document Version: 1.7
1010
Last Updated: 2026-04-01 20:24 UTC
11-
Verification Scope: README sections reviewed against docs/UPDATE_RULES.md and expanded with official model, software, and browser automation sources
1211
Repository: https://github.com/ReadyPixels/AI_Models_Matrix
1312

1413
## Table of Contents

0 commit comments

Comments
 (0)