Skip to content

Commit f49878c

Browse files
authored
Revise contribution guidelines for clarity
Updated contributing guidelines to clarify the process for requesting and suggesting changes to platforms.
1 parent ba578a2 commit f49878c

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
11
# Contributing to the Commerce Comparison
22

3-
We welcome contributions! To keep the data clean, please follow these rules:
4-
5-
### Adding a New Platform
6-
To add a platform (e.g., BigCommerce, Commercetools):
7-
1. Use the **45+ criteria** defined in the main README.
8-
2. Provide a source for pricing or technical specs where possible.
9-
3. Ensure the platform fits the "Commerce Platform" category.
10-
11-
### Editing Existing Data
12-
If you notice an error in the Shopify, Crystallize, or Norce data:
13-
1. Fork this repository.
14-
2. Edit `data/comparison.csv`.
15-
3. Submit a Pull Request with a brief note on what changed (e.g., "Updated Shopify's AI capabilities").
3+
We welcome contributions! I welcome updates to existing platforms or the addition of new ones. To maintain the integrity of the data, please follow these steps:
4+
5+
### 1. Requesting a New Platform
6+
If you want a platform covered but don't have all the data:
7+
* Open a **New Issue**.
8+
* Use the title `[Request]: Platform Name`.
9+
* The community or maintainers will help research the criteria.
10+
11+
### 2. Suggesting Changes (The Pull Request Process)
12+
If you have the data and want to update the table directly:
13+
1. **Fork** this repository.
14+
2. Edit the `data/comparison.csv` file.
15+
3. **Requirement:** If adding a new platform, you **must** provide values for all 45+ criteria across our 5 categories:
16+
* **Technical** (Architecture, API, etc.)
17+
* **Features** (PIM, CMS, etc.)
18+
* **AI** (Agentic Commerce, GenAI, etc.)
19+
* **Pricing** (Fees, Entry costs, etc.)
20+
* **Support** (SLAs, Training, etc.)
21+
4. Submit a **Pull Request** with the heading `feat: add [Platform Name]` or `fix: update [Platform Name] specs`.
22+
23+
---

0 commit comments

Comments
 (0)