Skip to content

[FEATURE] Add CONTRIBUTING.md, CI validation, and JSON generation - #11

Open
urbantech wants to merge 1 commit into
mainfrom
feature/contributing-ci
Open

[FEATURE] Add CONTRIBUTING.md, CI validation, and JSON generation#11
urbantech wants to merge 1 commit into
mainfrom
feature/contributing-ci

Conversation

@urbantech

Copy link
Copy Markdown
Contributor

Summary

  • CONTRIBUTING.md: Full guide covering fork/edit/PR workflow, YAML schema with all fields explained (required vs optional), category guidelines (pick most specific, 3+ tools per new category), self-submit via ainative.studio/open-source (coming soon), and issue-based alternative
  • GitHub Actions CI (.github/workflows/validate.yml): Runs scripts/validate.py on every PR touching data/**
  • scripts/validate.py: Validates YAML syntax, required fields (name/slug/description/category), unique slugs across files, categories exist in categories.yaml, and URL format
  • scripts/generate-json.py: Converts YAML data to dist/ainative-projects.json, dist/ecosystem-tools.json, dist/categories.json
  • Seed data: 15 categories, 6 AINative projects, 15 ecosystem tools

Test Plan

  • python scripts/validate.py passes with 21 entries, 0 errors
  • python scripts/generate-json.py produces 3 JSON files in dist/
  • CI workflow triggers on PRs touching data/**

Refs #5, #6, #8

- CONTRIBUTING.md with full guide: fork/edit/PR workflow, YAML schema
  reference, category guidelines, self-submit and issue alternatives
- GitHub Actions workflow to validate data on PRs touching data/**
- scripts/validate.py: checks YAML syntax, required fields, unique slugs,
  valid categories, and URL format
- scripts/generate-json.py: converts YAML to JSON in dist/ for site consumption
- Seed data: categories.yaml (15 categories), ainative-projects.yaml (6 projects),
  ecosystem-tools.yaml (15 tools)

Refs #5, #6, #8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant