Skip to content

Latest commit

 

History

History
80 lines (62 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

80 lines (62 loc) · 2.47 KB

Contributing to Unitflip

Thank you for considering contributing to Unitflip! We welcome contributions from the community and are excited to see how you can help improve the project.

Table of Contents

Code of Conduct

Please read and follow our Code of Conduct to ensure a welcoming and inclusive environment for everyone.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue on our GitHub Issues page. Include as much detail as possible to help us understand and reproduce the issue.

Suggesting Features

We welcome feature suggestions! Please open an issue on our GitHub Issues page and describe the feature you would like to see, along with any relevant use cases.

Submitting Pull Requests

  1. Fork the repository to your own GitHub account.
  2. Clone the repository to your local machine: 
    git clone https://github.com/your-username/unitflip.git
  3. Create a new branch for your feature or bugfix: 
    git checkout -b feature-or-bugfix-name
  4. Make your changes and commit them with clear and descriptive commit messages.
  5. Push your changes to your forked repository: 
    git push origin feature-or-bugfix-name
  6. Open a pull request on the original repository and provide a detailed description of your changes.

Development Setup

  1. Clone the repository: 
    git clone https://github.com/zshaian/unitflip.git
  2. Install dependencies: 
    npm install
  3. Run the development server: 
    npm run dev
  4. Build the project: 
    npm run build
  5. Run tests: 
    npm run test

Style Guide

  • Follow the existing code style and conventions.
  • Use meaningful variable and function names.
  • Write clear and concise commit messages.
  • Ensure your code is well-documented and includes comments where necessary.

License

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