Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
Improve Contributing Docs #3525
Description of the Change
I want to start contributing more to mocha from a code and documentation perspective and thought I'd start the same way I do with any other repo, by reading the CONTRIBUTING.md. In doing so, I found some broken links, as well as a reference to a node version no longer in LTS. This PR addresses those issues, as well as adds a link the README.md file, so that the information required to help others contribute is more easily found before they make their first commit.
Why should this be in core?
I think it will be useful to others that wish to contribute. Broken links and outdated information can be frustrating for folks.
Improved contributing documentation.
Mark Owsiak seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
My commits were initially signed with my Groupon email account. I rebased the commits so that they were authored under my personal email address that I signed the CLA with
Hey! Quick note in case you weren't aware.
By adding "[skip ci]" to end of your commit message, GitHub won't trigger a build.
$ git commit -m "docs: README update [skip ci]"