git-scm.com icon indicating copy to clipboard operation
git-scm.com copied to clipboard

Update: (root) README

Open RafaelJohn9 opened this issue 7 months ago • 6 comments

Changes

  • [x] Updated README

Context

I’ve updated the README.md to improve the overall clarity and structure. The goal of these changes is to make it easier for new contributors and developers to understand how to set up the project locally, run tests, and begin contributing. I’ve tried to keep the original intent and flow intact, while rewording or reorganizing certain sections for better readability and guidance.

Thank you for your time and for reviewing the changes!

RafaelJohn9 avatar May 21 '25 15:05 RafaelJohn9

I'd just like to state that I stopped at only two comments because I anticipate that it will be much easier to review and improve this PR once the changes are broken up into a proper set of commits, not because there is nothing more to comment on.

dscho avatar May 22 '25 08:05 dscho

Hey @dscho , I understand your concerns, I'll redo this PR in the manner you have suggested.

RafaelJohn9 avatar May 22 '25 08:05 RafaelJohn9

Hey @dscho , I understand your concerns, I'll redo this PR in the manner you have suggested.

@RafaelJohn9 thank you.

BTW if I were you, I'd use the technique described in https://git-scm.com/docs/git-rebase#_splitting_commits to avoid redoing the PR but instead simply splitting all the existing changes into appropriate commits. I find that git checkout -p <original-huge- commit> helps me with such tasks.

dscho avatar May 22 '25 09:05 dscho

thanks :+1: ,

everyday is a new learning day :sweat_smile:

RafaelJohn9 avatar May 22 '25 16:05 RafaelJohn9

everyday is a new learning day 😅

Totally!

dscho avatar May 22 '25 17:05 dscho

Hey @dscho,

what's your opinion on this PR ?

RafaelJohn9 avatar May 29 '25 18:05 RafaelJohn9

Hey @dscho , Thank you for your detailed review ,

I apologize if this PR seems like a mess and does not satisfy your standards. if its okay, I would like to close this for now and create issues while submitting PRs. That would make it easier to review and make our discussion not so over the place and rather be concentrated into specific points.

RafaelJohn9 avatar Jul 02 '25 19:07 RafaelJohn9

if its okay, I would like to close this for now and create issues while submitting PRs.

Totally okay with me. But as I said, I am not the maintainer of this site (even if it seems that the onus of reviewing and merging PRs somehow falls mostly on me, I guess I wasn't up in the tree at the count of three).

dscho avatar Jul 02 '25 19:07 dscho

hey @dscho ,

you are who we work with :) :+1:

RafaelJohn9 avatar Jul 02 '25 19:07 RafaelJohn9