code-review-pals icon indicating copy to clipboard operation
code-review-pals copied to clipboard

Published 20 hours ago • verified publisher icon CodeReviewPals

Update documentation

Open vassilidev opened this issue 2 years ago • 5 comments

Discussed in https://github.com/geeksesi/code-review-pals/discussions/64

Originally posted by olarno April 16, 2023 Hello, I think it would be good to update the documentation for new developers.

  • How to install locally. - At least
  • How to start your contribution, your first problem, your first report.
  • How to make a good review

Maybe add more details about the current stack: Laravel / react with their version.

Another question: do you have a template for PR?

Just a suggestion to be more readable.

vassilidev avatar Apr 16 '23 13:04 vassilidev

I can take this issue.

olarno avatar Apr 16 '23 15:04 olarno

About the template for PR, do you want to implement one ? I can add one or two to decide which is better.

olarno avatar Apr 16 '23 15:04 olarno

About the template for PR, do you want to implement one ?

I can add one or two to decide which is better.

U can do whatever u want, make a PR and we'll see if its good enough for us !

vassilidev avatar Apr 16 '23 17:04 vassilidev

do not forget we have Sail here 😉

geeksesi avatar Apr 17 '23 06:04 geeksesi

Updated doc with #78 for the first installation, need to add some for the open source workflow and best-practices

dorianlongepee avatar May 06 '23 12:05 dorianlongepee