Contributing

Contributing to SoloType

We welcome contributions to help improve SoloType! Whether it's fixing bugs, adding features, or improving documentation, your help is appreciated.

How to Contribute

We use the standard GitHub Fork & Pull Request workflow:

1. Fork the Repository: Create your own copy of the jay-021/SoloType repository by clicking the "Fork" button on GitHub.
2. Clone Your Fork: Clone your forked repository to your local machine.

   git clone [https://github.com/YOUR_USERNAME/SoloType.git](https://github.com/YOUR_USERNAME/SoloType.git)
   cd SoloType

3. Create a Branch: Create a new branch for your changes. Use a descriptive name (e.g., feature/add-new-theme, fix/results-display-bug).

   git checkout -b feature/your-feature-name

4. Make Changes: Implement your feature or fix the bug. Follow the setup guide in Local Development Setup to run the project locally.
5. Commit Changes: Make clear, concise commits.

   git add .
   git commit -m "feat: Add feature X"
   # or: git commit -m "fix: Correct bug Y in component Z"

6. Push to Your Fork: Push your changes to your forked repository on GitHub.

   git push origin feature/your-feature-name

7. Open a Pull Request: Go to the original jay-021/SoloType repository on GitHub. You should see a prompt to create a Pull Request from your recently pushed branch. Click it, review your changes, add a clear title and description explaining your contribution, and submit the Pull Request.

Code Style

Please try to adhere to the existing code style (TypeScript, React functional components, Tailwind CSS utility classes) and project structure. Ensure your code is well-commented where necessary.

Reporting Issues

If you find a bug or have a feature request, please check the Issues tab first to see if it already exists. If not, feel free to open a new issue with a clear description.

Thank you for contributing!