Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (40 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 1.33 KB
Raw

Contributing to zimme-zoom

Thank you for your interest in contributing to zimme-zoom! This document provides guidelines and instructions for contributing.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/zimme-zoom.git
  3. Install dependencies: yarn install
  4. Create a new branch: git checkout -b feature/your-feature-name

Development

Running Storybook

To see your changes in action, run Storybook:

yarn storybook

Building

Build the library:

yarn build

Code Style

  • Follow the existing code style
  • Run the linter: yarn lint
  • Format code: yarn format

Making Changes

  1. Make your changes in the src/ directory
  2. Add or update stories in src/stories/ if needed
  3. Test your changes in Storybook
  4. Ensure the build passes: yarn build

Submitting Changes

  1. Commit your changes with a clear message
  2. Push to your fork
  3. Create a Pull Request with a description of your changes

Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub with:

  • A clear description
  • Steps to reproduce (for bugs)
  • Expected vs actual behavior
  • Any relevant code examples

Questions?

Feel free to open an issue for any questions or discussions about the project.

Thank you for contributing! 🎉