docs: update README and CONTRIBUTING with new development tools
- Add Quick Start section to README with make commands - Add Development Tools section to CONTRIBUTING - Link to new documentation guides (QUICK_START.md, WORKFLOW_GUIDE.md) - Update development workflow section with modern tooling - Add clear onboarding path for new contributors Co-authored-by: jmiller-moko <230051081+jmiller-moko@users.noreply.github.com>
This commit is contained in:
@@ -48,6 +48,37 @@ Contributors are expected to:
|
||||
* Have a working understanding of Joomla template structure.
|
||||
* Be familiar with Git and GitHub pull request workflows.
|
||||
* Review repository governance documents prior to submitting changes.
|
||||
* Set up the development environment using the provided tools.
|
||||
|
||||
### Quick Setup
|
||||
|
||||
For first-time contributors:
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/mokoconsulting-tech/moko-cassiopeia.git
|
||||
cd moko-cassiopeia
|
||||
|
||||
# Run development setup
|
||||
make dev-setup
|
||||
|
||||
# Install Git hooks (optional but recommended)
|
||||
./scripts/git/install-hooks.sh
|
||||
```
|
||||
|
||||
See [docs/QUICK_START.md](./docs/QUICK_START.md) for detailed setup instructions.
|
||||
|
||||
## Development Tools
|
||||
|
||||
The repository provides several tools to streamline development:
|
||||
|
||||
* **Makefile**: Common development tasks (`make help` to see all commands)
|
||||
* **Pre-commit Hooks**: Automatic local validation before commits
|
||||
* **VS Code Tasks**: Pre-configured tasks for common operations
|
||||
* **Validation Scripts**: Located in `scripts/validate/`
|
||||
* **CI/CD Workflows**: Automated testing and deployment
|
||||
|
||||
Run `make validate-required` before submitting PRs to catch common issues early.
|
||||
|
||||
## Contribution Workflow
|
||||
|
||||
|
||||
Reference in New Issue
Block a user