search

gbowne1 / codebooker

This is a book recommendation app created with React 18.2 and MUI for coders/programmers looking for reccomendations to books on programming/coding to read
MIT License
31 stars 57 forks source link

Update to the contributing.md file #183

Closed Chizobaonorh closed 1 year ago

Chizobaonorh commented 1 year ago

I made significant changes and rewrote the contributing.md file for easy comprehension, and also added graphic images for easy navigation. @gbowne1 @LOGESH-B @BlackBond06

Chizobaonorh commented 1 year ago

@gbowne1 @Chizobaonorh

I can't find any steps to setup the .env for backend and instruction to run the setup.js file. It is very important to setup this project locally

I am not sure this was meant to be included in the contributing file, my best guess would be for this to be included in the devsetup file

gbowne1 commented 1 year ago

@LOGESH-B This file CONTRIBUTING.md is basically all about how to contribute which would include only information on how to clone/fork, pull requests, making bug reports, creating issues, maybe even links to the TODO list

We should include somehow within the file, that we require a minimum of two (2) reviews to be completed before we will merge.

DEVSETUP.md can house all of the things necessary for the developer to get their environment set up and working.

Chizobaonorh commented 1 year ago

The changes to this PR look good.

Some things ideally could be summarized, though.

Approving for merge.

Can you point out the things you think i can summarize?

gbowne1 commented 1 year ago

Lets wait for that till we finish what we have.

gbowne1 commented 1 year ago

Alright, merging now. Thanks for your contribution @Chizobaonorh and the opportunity to review your PR.