diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..173034f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,53 @@ + +# Contributing to Pluto Theme Mode + +Thank you for considering contributing to Pluto Theme Mode! Here are the steps to get started: + +## How to Contribute + +1. **Fork the repository** to your GitHub account. +2. **Clone your fork** to your local machine: + ```bash + git clone https://github.com/your-username/pluto-theme-mode.git + ``` +3. **Create a new branch** for your feature or fix: + ```bash + git checkout -b feature/your-feature-name + ``` +4. **Make your changes** to the code. +5. **Commit your changes** with a meaningful message: + ```bash + git commit -m "Your detailed commit message" + ``` +6. **Push your changes**: + ```bash + git push origin feature/your-feature-name + ``` +7. **Open a pull request** to the `main` branch of the original repository. + +## Development Setup + +To set up the development environment locally, follow these steps: + +1. **Clone the repository**: + ```bash + git clone https://github.com/ChakkritGit/pluto-theme-mode.git + ``` +2. **Install dependencies**: + ```bash + npm install + ``` +3. **Run the development server**: + ```bash + npm start + ``` + +## Testing + +To run tests for this project, use: + +```bash +npm test +``` + +Thank you for your contribution!