Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 1.49 KB

File metadata and controls

54 lines (35 loc) · 1.49 KB

Contributing to Markdown Shop

Thank you for your interest in contributing! 🚀

How to Contribute

  • Fork the repository and create your branch from develop.
  • Describe your changes clearly in your pull request.
  • Add tests for new features or bug fixes when possible.
  • Lint your code and ensure all tests pass before submitting.

Development Setup

  • Node.js 18+ and npm 9+
  • Install dependencies: npm install
  • Start the dev server: npm run dev

Quality Checks

  • Lint: npm run lint
  • Auto-fix lint issues: npm run lint:fix
  • Format: npm run format
  • Check formatting: npm run format:check

Code Style

  • Follow the existing code style and structure.
  • Use clear, descriptive commit messages.

Design System Requirements

Reporting Issues

  • Use the issue templates for bugs or feature requests.
  • Provide as much detail as possible.

Security Issues

  • Please do not report security vulnerabilities through public issues.
  • See SECURITY.md for the preferred reporting process.

Community


Happy contributing! 🎉