Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

62 lines (45 loc) · 2.7 KB
Raw

Contributing to Code Sync

We welcome contributions to the Code Sync project! Whether you're reporting a bug, suggesting a new feature, or fixing a typo, your input is valuable to us. Here are some guidelines to help you get started:

Thank you for considering contributing to code sync! Follow the steps below to contribute:

Getting Started

  1. Fork the Repository: Click the "Fork" button at the top right of the repository page on GitHub to create your copy.

  2. Clone the Repository: Clone your forked repository to your local machine:

    git clone https://github.com/<your_username>/Code-Sync.git

Making Changes

  1. Implement Your Contribution: Make your changes, ensuring they align with the project's goals.
  2. Test Your Changes: Test thoroughly to ensure everything works as expected.
  3. Switch to Your Branch: Before making changes, switch to your feature branch: 
    git checkout <your_branch_name>
  4. Commit Changes: Commit your changes with a clear message: 
    git add .
git commit -m "Add a description of your changes"
  5. Push Changes: Push your changes to your forked repository: 
    git push origin <your_branch_name>

Submitting a Pull Request

  1. Create a Pull Request: Go to your forked repository on GitHub, create a new Pull Request with a clear title and description.
  2. Describe Changes: Clearly describe the changes you made and why they are valuable.
  3. Review: Your PR will be reviewed by project maintainers. Be responsive to feedback.
  4. Merge: Once approved, your contribution will be merged into the main branch.

Reporting Bugs

If you find a bug while using Code Sync, please report it by opening an issue on Github. Please include the following information:

  • Description of the bug
  • Steps to reproduce the bug
  • Screenshots or videos demonstrating the bug, if possible
  • The expected outcome vs. the actual outcome
  • Any other relevant information, such as the operating system and browser version you are using.

Suggesting New Features

If you have an idea for a new feature, please let us know by opening an issue on Github. Describe the proposed feature and the benefits it would bring to the project. We appreciate well thought out suggestions, so please consider including mockups, diagrams, or examples to illustrate your point.

Fixing Typos

If you notice a spelling mistake or grammatical error in the project's documentation or comments, please correct it and submit a pull request. Thank you!

Thank You!

Thank you for contributing to Code Sync! Your efforts make a difference. If you have questions or need assistance, contact the project maintainers.

Happy contributing!