Skip to content

Latest commit

 

History

History
103 lines (65 loc) · 3.63 KB

CONTRIBUTING.md

File metadata and controls

103 lines (65 loc) · 3.63 KB
Raw

💥 How to Contribute

PRs Welcome

  • Take a look at the existing Issues or create a new issue!
  • Fork the Repo. Then, create a branch for any issue that you are working on. Finally, commit your work.
  • Create a Pull Request (PR), which will be promptly reviewed and given suggestions for improvements by the community.
  • Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR.

⭐ HOW TO MAKE A PULL REQUEST:

1. Start by making a Fork of the Video-Chat-App--main repository. Click on the Fork symbol at the top right corner.

2. Clone your new fork of the repository in the terminal/CLI on your computer with the following command:

git clone https://github.com/<your-github-username>/Video-Chat-App--main

3. Navigate to the newly created Video-Chat-App--main project directory:

cd Video-Chat-App--main

4. Set upstream command:

git remote add upstream https://github.com/JavascriptDon/Video-Chat-App--main.git

5. Create a new branch:

git checkout -b YourBranchName

6. Sync your fork or your local repository with the origin repository:

  • In your forked repository, click on "Fetch upstream"
  • Click "Fetch and merge"

Alternatively, Git CLI way to Sync forked repository with origin repository:

git fetch upstream
git merge upstream/main

Github Docs for Syncing

7. Make your changes to the source code.

8. Stage your changes:

⚠️ Make sure not to commit package.json or package-lock.json file

⚠️ Make sure not to run the commands git add . or git add *

Instead, stage your changes for each file/folder

By using public path it means it will add all files and folders under that folder, it is better to be specific

git add public

or

git add "<files_you_have_changed>"

9. Commit your changes:

git commit -m "<your_commit_message>"

10. Push your local commits to the remote repository:

git push origin YourBranchName

11. Create a Pull Request!

12. Congratulations! You've made your first contribution to Video-Chat-App--main! 🙌🏼

🏆 After this, the maintainers will review the PR and will merge it if it helps move the Video-Chat-App--main project forward. Otherwise, it will be given constructive feedback and suggestions for the changes needed to add the PR to the codebase.

💥 Issues

In order to discuss changes, you are welcome to open an issue about what you would like to contribute. Enhancements are always encouraged and appreciated.

All the best! 🥇