- 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
- 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 the main branch, create your own branch by following the instructions here
- If you are working on the backend, share a screenrecording of your working software
- Do read the
readme.md
file - If there's no activity on an issue/pull request in one week, it gets closed and the person can't have it resigned to them, make sure to give updates on things so maintainers don't think you aren't doing anything.
- 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
pull.request.template.webm
- 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
orcloses #123
where #123 is the issue you worked on. It should not befixes issue #123
- Your PR description should also have the changes you did e.g added a new component, added a new image.
- 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.
- 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