-
Notifications
You must be signed in to change notification settings - Fork 282
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(build): add text build steps for Mac #3421
docs(build): add text build steps for Mac #3421
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need doc formatting and specifics like installing go
page should be updated, nvm installation
steps, etc
8697f36
to
d7552ac
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ashnashahgrover Looking good, just a few nit-picks:
- Change the commit message and PR title to reflect the contents a little closer:
You added instructions for Mac and placeholders for Linux, Windows. Someone reading this commit message would most likely end up thinking that they are about to read the instructions on how to set the project up on Linux and the get greeted by disappointment [1]. - Explicitly clarify if you are talking about intel or ARM macs unless you've tested the steps on both CPU architectures. If you did test it both and it works that's awesome and we should make sure that it's explicitly stated as well.
[1]:
### Linux
* Insert Linux instructions here
d7552ac
to
f33dbf8
Compare
f33dbf8
to
b8da32d
Compare
LGTM too |
Jagpreet said LGTM in the meantime, he probably just forgot to mark his change request resolved.
Primary Changes ---------------- 1. Updated BUILD.md to include Mac OS specific installation instruction 2. Added placeholders for Linux and Windows specific instructions. Fixes hyperledger-cacti#1963 Signed-off-by: ashnashahgrover <as19@williams.edu>
b8da32d
to
679dd2e
Compare
Commit to be reviewed
docs(build): add text build steps for Mac
Fixes #1963
Signed-off-by: ashnashahgrover as19@williams.edu
Pull Request Requirements
upstream/main
branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.-s
flag when usinggit commit
command. You may refer to this link for more information.Character Limit
A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.