Skip to content
This repository was archived by the owner on Sep 25, 2025. It is now read-only.

Docs: Add Windows notes, .env section, make formatting consistent, fix typos to CONTRIBUTING.md - #466

Merged
allella merged 14 commits into
freeCodeCamp:masterfrom
allella:docs/windows-contributing
Mar 31, 2021
Merged

Docs: Add Windows notes, .env section, make formatting consistent, fix typos to CONTRIBUTING.md#466
allella merged 14 commits into
freeCodeCamp:masterfrom
allella:docs/windows-contributing

Conversation

@allella

@allellaallella commented Mar 30, 2021

Copy link
Copy Markdown
Contributor
  • I have read Chapter's contributing guidelines.
  • My pull request has a descriptive title (not a vague title like Update README.md).
  • My pull request targets the master branch of Chapter.

Edit(Oliver):
Closes#465
Closes#462

I hope that edit is okay, @allella. I wasn't sure it closed 447, so I left that alone.

@gitpod-io

gitpod-ioBot commented Mar 30, 2021

Copy link
Copy Markdown

@allella

Copy link
Copy Markdown
ContributorAuthor

@paizle and @NorthDecoder I wanted to add you add you as reviewers but GitHub won't let me. I think we figured it's because you haven't already commented on the PR and/or something to do with starring the project or the freeCodeCamp team settings.

In any case, I'd appreciate if you can look at the changes. Viewing it at https://github.com/allella/chapter/blob/docs/windows-contributing/CONTRIBUTING.md is the only sane way to review the changes.

@paizle

Copy link
Copy Markdown
Contributor

@paizle and @NorthDecoder I wanted to add you add you as reviewers but GitHub won't let me. I think we figured it's because you haven't already commented on the PR and/or something to do with starring the project or the freeCodeCamp team settings.

In any case, I'd appreciate if you can look at the changes. Viewing it at https://github.com/allella/chapter/blob/docs/windows-contributing/CONTRIBUTING.md is the only sane way to review the changes.

The docs look ok to me. As far as I can tell, Git Bash on Windows seems to work fine for me at this point.

@ojeytonwilliamsojeytonwilliams left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good All I found was a single typo.

Comment threadCONTRIBUTING.md Outdated
Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>
@allella

Copy link
Copy Markdown
ContributorAuthor

@ojeytonwilliams how about I do a find and replace on yarn to npm in this doc and then you revert your CONTRIBUTING.md, so we can avoid a conflict?

@allella

Copy link
Copy Markdown
ContributorAuthor

@nhcarrigan could you take a look at Contributing Code >> Step 2 - Prepare the Development Environment of my PR for CONTRIBITING.md to see if the Windows related terminal / shell notes look good?

@naomi-lgbt

Copy link
Copy Markdown
Member

That section looks good to me. 🙂

@allella
allella merged commit 0197110 into freeCodeCamp:masterMar 31, 2021
@allella
allella deleted the docs/windows-contributing branch March 31, 2021 17:06
@allella

Copy link
Copy Markdown
ContributorAuthor

@allcontributors

Copy link
Copy Markdown
Contributor

@allella

I've put up a pull request to add @nhcarrigan! 🎉

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Handling symlinks on Windows Add npm run postinstall to contributing.md

5 participants

@allella@paizle@naomi-lgbt@NorthDecoder@ojeytonwilliams