Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

70 lines (43 loc) · 1.99 KB

Welcome to DevSync

Thank you for considering contributing to DevSync! Whether you're here to report a bug, suggest a feature, or fix a typo, your help is greatly appreciated. Below are guidelines to get you started:

Getting Started

  1. Fork the Repository: Click the "Fork" button on GitHub's top-right to create your own copy.

  2. Clone the Repository: Clone your fork to your local machine:

    git clone https://github.com/<your_username>/devsync.git

Making Changes

  1. Implement Your Changes: Make your modifications, ensuring they align with the project's objectives.

  2. Test Your Changes: Verify your changes to ensure everything functions correctly.

  3. Switch to Your Branch: Before making changes, switch to your feature branch:

    git checkout <your_branch_name>

  4. Commit Your Changes: Commit with a clear message:

    git add .
git commit -m "type: Describe your changes in present tense"

  5. Push Your Changes: Push to your forked repository:

    git push origin <your_branch_name>

Submitting a Pull Request

  1. Create a Pull Request: Visit your fork on GitHub, create a PR with a descriptive title and explanation.

  2. Detail Your Changes: Clearly outline your modifications and their significance.

  3. Review Process: Expect feedback from project maintainers; be responsive.

  4. Merge: Once approved, your contribution will merge into the main branch.

Reporting Issues

Encountered a bug? Report it on GitHub. Include:

  • Bug description
  • Reproduction steps
  • Screenshots or videos (if possible)
  • Expected vs. actual outcomes
  • OS and browser details

Suggesting Features

Have a new idea? Open an issue. Detail the feature and its benefits. Mockups or examples are appreciated.

Fixing Errors

Spotted a typo? Correct it in the docs or comments and submit a PR. Thanks!

Thank You!

Your contribution matters. For questions, reach out to project maintainers.

Happy coding!