Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (38 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

59 lines (38 loc) · 2.13 KB
Raw

Contributing to Drupal + Astro Starter Kit

Thanks for your interest in contributing! This is an Alpha-stage project — feedback and bug reports are especially valuable right now.

How to test changes

There is no automated test suite. Validate changes by running the setup flow end-to-end:

# From the repo root
chmod +x setup.sh
./setup.sh

A successful run creates drupal-backend/ and astro-frontend/. Then verify:

# Confirm Drupal JSON:API responds
cd drupal-backend && ddev start
# Visit http://<project>.ddev.site/jsonapi in your browser

# Confirm Astro builds successfully
cd ../astro-frontend && npm run build
# Check that dist/ is generated with HTML files

The audit toolkit provides structured, non-mutating checks:

cd audit && npm install && npm run audit:all

Making changes

  • Setup flow changes belong in setup/ui.js and setup/cli.js
  • Astro template changes belong in templates/astro-src/ (not in the generated astro-frontend/)
  • Script changes belong in scripts/
  • Documentation changes belong in docs/ or README.md

Never edit drupal-backend/ or astro-frontend/ directly — these are generated by ./setup.sh and are gitignored.

Internal tooling files

.agent/execplans/ — Internal planning documents used by maintainers and AI agents to track feature work and decisions. Not required reading for contributors, but available if you want to understand the project's evolution.

.github/agents/ and .github/prompts/ — Optional AI workflow tools for maintainers. Contributors do not need to use them.

Reporting bugs and giving feedback

Use the GitHub issue templates:

  • Bug report — for failures during setup, build, or deployment
  • Setup feedback — for anything confusing, unclear, or that could be improved

Issues are the best way to contribute at this stage. Every report helps.

License

By contributing, you agree that your contributions will be licensed under the MIT License (for tooling/templates) or GPL-2.0-or-later (for Drupal recipe packages), as appropriate for the component you are modifying. See LICENSE for details.