Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (36 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

48 lines (36 loc) · 1.48 KB

Contributing to ChatApp

Thank you for your interest in contributing to ChatApp! We welcome all kinds of contributions—bug fixes, new features, documentation, and more.

1. Fork & Clone

  1. Fork the repository to your own GitHub account by clicking the "Fork" button at the top right of the project page.
  2. Clone your forked repository to your local machine: 
    git clone https://github.com/YOUR_USERNAME/ChatApp.git
cd ChatApp
  3. Add the original repository as an upstream remote: 
    git remote add upstream https://github.com/ORIGINAL_OWNER/ChatApp.git

2. Branch Naming Rules

  • Always create a new branch for your work (do not commit directly to main).
  • Use descriptive names for your branches. Examples:
    • fix/login-bug
    • feature/collaborative-editor
    • docs/update-readme
  • Branch names should be lowercase and use hyphens to separate words.

3. How to Submit a Pull Request

  1. Create your branch and make your changes.
  2. Commit your changes with clear, descriptive messages.
  3. Push your branch to your forked repository: 
    git push origin your-branch-name
  4. Go to the original ChatApp repository on GitHub.
  5. Click "Compare & pull request" next to your branch.
  6. Fill out the pull request template, describing your changes and why they are needed.
  7. Submit the pull request.

We will review your pull request as soon as possible. Thank you for helping make ChatApp better!