Skip to content

Latest commit

 

History

History
67 lines (51 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

67 lines (51 loc) · 2.55 KB

Contributing to Mantine Theme Builder

We are excited that you're interested in contributing to Mantine Theme Builder! This guide will help you get started with contributing code, reporting issues, or suggesting new features.

How to Contribute

There are many ways to contribute to this project:

  • Reporting Bugs: If you've found a bug, please open an issue with a clear description of the problem, steps to reproduce, and any error messages.
  • Feature Requests: Got an idea for a new feature? We welcome suggestions. Please provide a detailed description of the feature and how it would improve the project.
  • Code Contributions: We love receiving pull requests! Check out our guidelines for contributing code below.

Getting Started

To start contributing, follow these steps:

  1. Fork the repository: Click the "Fork" button at the top of this repo and clone it to your local machine. 
    git clone https://github.com/your-username/mantine-theme-builder.git
cd mantine-theme-builder
  2. Install dependencies: Install the necessary dependencies to run the project. 
    npm install
  3. Make your changes: Create a new branch for your feature or bug fix. 
    git checkout -b your-branch-name
  4. Test your changes: Run the project locally to ensure everything works as expected. 
    npm start
  5. Generate updated themes: If you have updated any theme or style files, run the following command to regenerate the updated themes. 
    npm run generate
  6. Commit your changes: Once you're satisfied with your changes, commit them. 
    git commit -m "Description of your changes"
  7. Push your changes: Push your changes to your forked repo. 
    git push origin your-branch-name
  8. Submit a pull request: Go to the original repo on GitHub and submit a pull request with a clear description of your changes.

Code Style

Please ensure your code follows these guidelines:

  • Use Prettier for code formatting to keep the codebase clean and consistent.
  • Follow the standard JavaScript or TypeScript best practices.
  • Ensure that your code is properly documented and tested where applicable.

Issue Reporting

When reporting issues, please ensure that you include:

  • A detailed description of the issue.
  • Steps to reproduce the bug.
  • Screenshots or code snippets (if applicable).

License

By contributing to Mantine Theme Builder, you agree that your contributions will be licensed under the MIT License.