Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 2.89 KB

Contribution.md

File metadata and controls

71 lines (46 loc) · 2.89 KB
Raw

typed-css-modules Contribution Guidelines

Welcome to the typed-css-modules project! We appreciate your interest in contributing to the project. This document outlines the guidelines for contributing to the project to help maintain a healthy and collaborative development environment.

Table of Contents

  • Getting Started
  • Code of Conduct
  • How to Contribute
  • Reporting Bugs
  • Submitting Enhancements
  • Code Contributions
  • Style Guidelines
  • License

Getting Started

Before you begin contributing, please make sure you have:

  1. Node.js and npm installed on your system.
  2. A GitHub account for version control and issue tracking.
  3. Make sure you are using the newly released version.
  4. Familiarize yourself with the project by reviewing the example in this repository example folder and understanding its goals.

Code of Conduct

Please maintain the expected behavior and conduct within the project's community.

How to Contribute

We welcome contributions in the following ways:

Reporting Bugs

If you find any bugs or issues with the project, please submit a new issue on GitHub. Make sure to provide detailed information about the bug and steps to reproduce it.

Submitting Enhancements

If you have an idea for an enhancement or a new feature, create an enhancement proposal in the Issues section. Discuss your proposal with the community before you start working on it.

Code Contributions

If you would like to contribute code to the project, please follow these steps:

  • Fork the repository on GitHub.

  • Clone your fork locally: git clone https://github.com/your-username/your-repo.git

  • Create a new branch for your changes: git checkout -b feature/your-feature

  • Make your changes and commit them with clear, concise messages.

  • Push your changes to your fork on GitHub: git push origin feature/your-feature

  • Create a Pull Request (PR) in the project repository, providing a detailed description of your changes and linking to any relevant issues.

  • Participate in the review process and make any necessary updates.

Style Guidelines

To maintain a consistent codebase, we follow a set of style guidelines for our code. These include but are not limited to:

  • Using TypeScript for all code.
  • Following CSS Modules TypeScript Demo guidelines of working demonstration of CSS Modules with React and TypeScript.
  • Adhering to consistent code formatting (we use Prettier) and indentation.
  • Writing clear and informative comments in code.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank you for considering contributing to the CSS Modules TypeScript project. Your contributions are valuable and help make the project better for everyone!