Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.49 KB

CONTRIBUTE.md

File metadata and controls

41 lines (27 loc) · 1.49 KB
Raw

Contributing to CSS-in-JS Utilities

We welcome contributions to the CSS-in-JS Utilities library! This document provides guidelines for contributing to the project.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally.
  3. Install dependencies with npm install.
  4. Create a branch for your contribution.

Development Workflow

  1. Make your changes in the appropriate files under the src directory.
  2. Add or update tests in the src/__tests__ directory to cover your changes.
  3. Ensure all tests pass by running npm test.
  4. Update the README.md if your changes require documentation updates.

Coding Standards

  • Write TypeScript code following the existing style in the project.
  • Use meaningful variable and function names.
  • Comment your code where necessary, especially for complex logic.

Submitting Changes

  1. Commit your changes with a clear and descriptive commit message.
  2. Push your changes to your fork on GitHub.
  3. Create a pull request against the main repository.
  4. Describe your changes in the pull request, including the motivation for the change and any relevant issue numbers.

Reporting Issues

  • Use the GitHub issue tracker to report bugs or suggest features.
  • Provide as much detail as possible, including steps to reproduce for bugs.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Thank you for contributing to CSS-in-JS Utilities!