Adding Compatibility Rules
Contribute compatibility data by submitting verified information about how two technologies work together.Before You Submit
Check if Data Exists
- Visit devradar.dev/check
- Search for your technology pair
- If status is “unknown”, your submission is valuable
Verify Your Information
Only submit what you’ve personally verified:| Verification Method | Acceptance |
|---|---|
| Personal testing | Preferred |
| Official docs | Accepted |
| GitHub issue | Accepted |
| Community consensus | Case-by-case |
- Technology names
- Compatibility status
- Evidence/source links
- Your testing context
What to Submit
Required Fields
| Field | Description | Example |
|---|---|---|
| Technology A | First technology name | nextjs |
| Technology B | Second technology name | prisma |
| Status | Compatibility level | compatible, partial, incompatible |
| Severity | Impact level | info, warning, error, critical |
| Explanation | Why this status | Detailed description |
| Evidence | Source links | Official docs, GitHub issues |
| Tested Versions | What you tested | [email protected], [email protected] |
Optional Fields
| Field | Description | Example |
|---|---|---|
| Workaround | Fix for partial/incompatible | ”Use dynamic imports” |
| Platform | Specific platform | ”web”, “mobile”, “edge” |
| Notes | Additional context | ”Only for API routes” |
Status Guidelines
Compatible ✅
Use when technologies work together without issues. Example:Partial ⚠️
Use when technologies work but with limitations. Example:Incompatible ❌
Use when technologies have fundamental conflicts. Example:Submission Methods
Method 1: GitHub Issue (Recommended)
- Go to github.com/devradar-dev/website/issues
- Click “New Issue”
- Use “Compatibility Data” template
- Fill in all fields
- Submit
Method 2: Discussion Post
For complex submissions or questions:- Go to github.com/devradar-dev/website/discussions
- Start a new discussion
- Use “Compatibility Data” category
- Post your submission
Method 3: API (Developers)
Submit via API (requires authentication):Review Process
What We Check
- Accuracy - Can we verify the information?
- Evidence - Are sources provided?
- Clarity - Is the explanation clear?
- Completeness - Are all required fields filled?
Timeline
| Stage | Duration |
|---|---|
| Initial review | 1-2 days |
| Verification | 2-3 days |
| Merge | Within 7 days |
After Submission
You’ll receive updates:- Under Review - Being evaluated
- Approved - Added to database
- Changes Requested - Needs more info
- Declined - Cannot accept (with reason)
Best Practices
1. Test Before Submitting
Actually use the technologies together:2. Document Your Context
Help us understand your setup:3. Link to Evidence
Strong sources strengthen your submission:- Official documentation (best)
- Official GitHub issues (good)
- Blog posts from maintainers (acceptable)
- Your own testing (with details)
4. Be Specific
5. Update When Versions Change
If you submitted data for older versions, submit updates when new versions release:What Happens After Approval
Your submission becomes part of the database:- Compatibility checks - API returns your data
- Scans - Projects scanned with this info
- Content - May be used in guides/comparisons
- Attribution - Your username credited (optional)
Examples
Example 1: Compatible
Example 2: Partial with Workaround
What’s Next
- Adding AI Tools - Submit tool information
- Contributing Overview - Other ways to contribute
- API Reference - API documentation
Submit now: Open an Issue →