Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
96 lines (66 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

96 lines (66 loc) · 1.75 KB

Contributing

Thank you for your interest in contributing to this application! This document provides guidelines and steps for contributing.

Development Setup

  1. Fork the repository

  2. Clone your fork:

git clone https://github.com/your-username/screen-sharing.git
  1. Navigate to the project directory:
cd screen-sharing
  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev

Alternatively, you can use Docker:

docker compose up

Making Changes

  1. Create a new branch:
git checkout -b feature/your-feature-name
  1. Make your changes
  2. Test your changes
  3. Commit your changes following Conventional Commits:
  • feat: New features
  • fix: Bug fixes
  • docs: Documentation changes
  • style: Code style changes (formatting, semicolons, etc)
  • refactor: Code refactoring
  • test: Adding or updating tests
  • chore: Maintenance tasks, dependencies
  • perf: Performance improvements
  • ci: CI/CD configuration changes
  • build: Changes to build system or dependencies

Example:

feat: add new feature
fix: resolve some bug
docs: update README
  1. Push to your fork:
git push origin feature/your-feature-name
  1. Open a Pull Request

Pull Request Guidelines

  • Follow the existing code style
  • Include clear description of changes
  • Keep changes focused and atomic
  • Add tests if applicable
  • Update documentation if needed

Questions or Problems?

Open an issue in the repository if you:

  • Found a bug
  • Have a feature request
  • Need help with setup

License

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