Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (35 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

45 lines (35 loc) · 1.61 KB

Contributing to CodeshareLive

First off, thank you for considering contributing to CodeshareLive! It's people like you that make CodeshareLive such a great tool.

How to Contribute

1. Fork & Create a Branch

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name

2. Make Your Changes

  • Ensure your code follows the existing style and conventions.
  • Make sure to test your changes locally.
  • For the frontend, run npm run dev in the client/ directory.
  • For the backend, run node src/index.js in the server/ directory.

3. Commit Your Changes

Commit your changes with clear, descriptive commit messages:

git commit -m "Add amazing feature"

4. Push to Your Fork

Push your branch to your forked repository:

git push origin feature/your-feature-name

5. Open a Pull Request

  • Go to the original CodeshareLive repository.
  • Click on "New pull request".
  • Select your branch and provide a detailed description of your changes, the problem they solve, or the feature they add.
  • Submit the PR for review!

Code Review Process

Once you've submitted a PR, the maintainers will review your code. We may ask for changes or provide feedback. Once everything looks good, your PR will be merged, and you will become an official contributor! 🎉

Reporting Issues

If you find a bug or have a feature request, please create an issue on GitHub. Include as much detail as possible to help us understand and resolve it quickly.

Thank you for contributing!