Skip to content

Latest commit

 

History

History
147 lines (96 loc) · 5.51 KB

CONTRIBUTING.md

File metadata and controls

147 lines (96 loc) · 5.51 KB
Raw

Table of content

Rules

  • Don't create a pull request on an issue that doesn't exist, create an issue first and if the changes you are proposing are said to be okay, you can go ahead and create a pull request

  • Don't work on anything unless you are assigned, if you make a pull request without being assigned to that issue, it will be closed without being merged

  • Don't work on more than one issue at a time, this is so that you don't make a huge pull request and others can have opportunities to work on another issue while you work on something else

  • Do read the readme.md file

  • Don't work on the main branch, create your own branch by following the instructions here

  • Fill out issue and pull request(PR) templates properly, if you don't know how, check out previous issues/PR to know how they are filled, this video👇🏾 or this

👌🏾 How to fill a pull request template(video)

pull.request.template.webm

👌🏾 How to fill a pull request template(Text)

  • Your PR title should be according to the conventional commit standards(link) for example, if the added something new to the project(doesn't matter how small), your PR title should be like this -> feat: added a text <- Whatever you added. If you fixed something then your PR title should be like this -> fix: wrong link <- whatever you fixed
  • Your PR description should have either fixes, closes with the issue number you worked on, for example, fixes #123 or closes #123 where #123 is the issue you worked on. It should not be fixes issue #123
  • Your PR description should also have the changes you did e.g added a new component, added a new image.

👩🏽‍💻 Prerequisite Skills to Contribute

Contribute in Components/CSS

Contribute in backend

💥 How to Contribute

  • 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.

Starting the Project without Docker

  • Navigate to the Client Folder 
    cd client
  • Start the client Side 
    npm start
  • Navigate to the Server Folder 
    cd server
  • Start the Server Side 
    nodemon index.js

    Note: you must have gotten past step 5 in "Installation" part of the readme file

🌟 HOW TO MAKE A PULL REQUEST:

  1. Start by making a Fork of the Whisper 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>/Whisper
  1. Navigate to the newly created Whisper project directory:
cd Whisper
  1. Set upstream command:
git remote add upstream https://github.com/Dun-sin/Whisper.git
  1. Create a new branch:
git checkout -b YourBranchName
  1. 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

  1. Make your changes to the source code.

  2. Stage your changes and commit:

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

git cz
  1. Push your local commits to the remote repository:
git push origin YourBranchName

  1. Create a Pull Request!

  2. Congratulations! You've made your first contribution to Whisper!

🏆 After this, the maintainers will review the PR and will merge it if it helps move the Whisper 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.