Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (38 loc) · 971 Bytes

CONTRIBUTING.md

File metadata and controls

45 lines (38 loc) · 971 Bytes

Contributing

Thanks for contributing to Flexiwind.

Ways to contribute

  • Report bugs with clear reproduction steps.
  • Propose improvements to components and docs.
  • Open pull requests for focused, reviewable changes.

Development setup

  1. Install dependencies:
composer install
npm install
  1. Prepare environment:
cp .env.example .env
php artisan key:generate
  1. Run the app:
composer dev

Quality checks

Run these before opening a PR:

php artisan test
npm run build

Pull request guidelines

  • Keep PRs scoped to one concern.
  • Include screenshots for UI changes.
  • Update docs when behavior changes.
  • Reference related issues in the PR description.

Commit guidance

Use clear, imperative commit messages, for example:

  • docs: clarify theme token usage
  • fix: add missing sidebar code snippet key

Code of conduct

By participating, you agree to follow the Code of Conduct in CODE_OF_CONDUCT.md.