Skip to content

Latest commit

 

History

History
87 lines (58 loc) · 4.17 KB

CONTRIBUTING.md

File metadata and controls

87 lines (58 loc) · 4.17 KB
Raw

Contribute to CSS Modules Transformer

Table of Contents

Introduction

Thank you for your interest in contributing to CSS Modules Transformer! This document outlines the guidelines for contributing to the project. By adhering to these guidelines, you can help us maintain a high-quality and sustainable codebase.

Getting Started

Before you start contributing, please take the following steps:

  1. Fork the Repository: Fork the CSS Modules Transformer repository on GitHub. This will create a copy of the repository in your own GitHub account.
  2. Clone the Forked Repository: Clone your forked repository to your local machine using the following command:
git clone https://github.com/<your-username>/css-modules-transformer.git
  1. Set Up a Development Environment: Set up a development environment on your local machine. This may involve installing necessary dependencies, configuring a code editor, and setting up a local development server.

Development Process

  1. Create a Feature Branch: When working on a new feature or fixing a bug, create a new feature branch from the main branch:
git checkout -b <your-feature-branch-name>

  1. Make Changes: Make your changes to the codebase in your feature branch. Follow the coding conventions and best practices to ensure code quality.

  2. Commit Changes: Commit your changes regularly using meaningful commit messages:

git add <files>
git commit -m "<commit-message>"
  1. Push Changes: Push your changes to your forked repository on GitHub:
git push origin <your-feature-branch-name>

  1. Create a Pull Request: Create a pull request to merge your feature branch into the main branch of the original repository. Provide a clear and concise description of your changes in the pull request.

  2. Review and Feedback: The project maintainers will review your pull request and provide feedback. Be prepared to address any feedback or suggestions to improve your contribution.

Code Contributions

When contributing code to CSS Modules Transformer, please adhere to the following guidelines:

  • Use concise and descriptive variable and function names.
  • Follow the coding conventions and best practices used in the existing codebase.
  • Write well-commented code to help other contributors understand your changes.
  • Ensure that your code is tested and passes all the existing tests.
  • Keep your changes focused and avoid introducing unrelated changes.

Reporting Issues

If you encounter any bugs or issues with CSS Modules Transformer, please report them using the GitHub issue tracker. When reporting an issue, please provide the following information:

  • A concise and descriptive title that summarizes the issue.
  • A detailed description of the issue, including steps to reproduce the issue and any relevant error messages or logs.
  • The version of CSS Modules Transformer you are using.
  • If possible, provide a minimal reproducible example that demonstrates the issue.

Open Source Community

Conduct

We are committed to fostering a welcoming and inclusive open-source community. We expect all contributors to adhere to our Code of Conduct to create a respectful and collaborative environment.

Contributor License Agreement

By contributing to CSS Modules Transformer, you agree to the terms of our Contributor License Agreement (CLA). The CLA ensures that we can use your contributions in accordance with the project's license.

Documentation

If you have any questions or need help using or contributing to CSS Modules Transformer, don't hesitate to ask for help on the project's GitHub page or through the project's communication channels (e.g., Discord, Slack, etc.). Additionally, our documentation provides comprehensive information about using and contributing to the project.