Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (45 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

60 lines (45 loc) · 1.58 KB

Contributing to Sync Space

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to Sync Space. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/sync-space.git
cd sync-space
  3. Install dependencies: 
    npm install
  4. Create a branch for your feature or bug fix: 
    git checkout -b my-feature-branch

Development

  • Run the development server: 
    npm run dev
  • Open http://localhost:3000 with your browser to see the result.

Code Style

We use Prettier for code formatting. Please ensure your code is formatted before submitting a PR.

  • Check formatting: 
    npm run format:check
  • Fix formatting: 
    npm run format

Submitting a Pull Request

  1. Push your branch to your fork: 
    git push origin my-feature-branch
  2. Open a Pull Request against the main branch of the original repository.
  3. Fill out the Pull Request template with details about your changes.

Reporting Bugs

Please use the Bug Report issue template to report bugs. Include as much detail as possible, including steps to reproduce and screenshots if applicable.

Requesting Features

Please use the Feature Request issue template to suggest new features or enhancements.