Skip to content

Latest commit

 

History

History
44 lines (33 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

44 lines (33 loc) · 1.83 KB
Raw

MERN Video Streaming

Intro

This project was created by me as a personal project, but I welcome community contributions. Please see the contributing guidelines below for more information.

Where to contribute

There are many ways to contribute to MERN Video Streaming, including:

  • Reporting bugs
  • Fixing bugs
  • Adding new features
  • Improving documentation
  • Writing tests
  • Adding new issues
  • And many more...

To contribute, please follow these steps:

  • Create an issue or pick an existing one which you want to work on
  • Fork the repository to your own GitHub account.
  • Clone the repository to your local machine.
  • Create a new branch to work on your changes.
  • Make your changes to the code or documentation.
  • Run the tests to make sure your changes work.
  • Commit your changes to your local repository.
  • Push your changes to your remote repository.
  • Open a pull request against the main repository.

Pull requests

The pull reqeust MUST link with any existing or new Issues, otherwise the pull request will not be even considered for review.

Once you have opened a pull request, a member of the project team (most of the time it is me) will review your changes. They may ask you to make some changes before the pull request can be merged. Once the pull request is merged, your changes will be available to everyone.

Thanks for contributing!

We appreciate your contributions to MERN Video Streaming! We hope you enjoy working on it as much as we do.

In addition to the general contributing guidelines above, here are some specific things to keep in mind when contributing to MERN Video Streaming:

  • Please use the latest version of the code when contributing.
  • Make sure your changes are well-tested.
  • Write clear and concise commit messages.
  • Document your changes in the README.md file.
  • Be respectful of other contributors.