Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(CONTRIBUTING): update links #932

Conversation

leschdom
Copy link
Contributor

What:
Update links (e.g. egghead.io link redirects to some old preview page for their newly launched site).
Renamed Typescript to TypeScript
(As I did with my first PR on the cypress-testing-library (testing-library/cypress-testing-library#180))

Why:
It could be confusing for first-time contributors (egghead.io links)
It gives a even more professional look when the naming of tools etc. is spelled correctly (at least to me 馃槄)

How:
Searched for the correct links:
OLD: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
NEW: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github

Have found a source to link why I would like to update the TypeScript spelling:
https://effectivetypescript.com/2021/02/03/pet-peeves/

Checklist:

  • Documentation added to the
    docs site N/A
  • Tests N/A
  • Typescript definitions updated N/A
  • Ready to be merged

... the old egghead.io link redirects to https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github
which displays "We've got a new version of egghead in BETA. Click here
to try it!"

remove obsolete all-contributors link (was removed in 29aad25)
@leschdom leschdom changed the title Feature/update contributing documentation docs(CONTRIBUTING): update links Jun 13, 2021
@codesandbox-ci
Copy link

codesandbox-ci bot commented Jun 13, 2021

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 97b5a99:

Sandbox Source
React Configuration
react-testing-library-examples Configuration

@nickmccurdy
Copy link
Member

I agree with using the spelling TypeScript which is consistent with Microsoft's spelling, but why is the Egghead link changed? It seems like both links work but use different themes. Do they have a new backend?

@leschdom
Copy link
Contributor Author

Hi @nickmccurdy

Thanks for reviewing my PR.
So the reason I wanted to change the link is, that it still looks "unofficial" - while technically the videos etc. seem to be available.

For example the link on top:
"We've got a new version of egghead in BETA. Click here to try it! 鈿★笍" . After clicking on it I come to https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github.
image

So the page used to be in Beta some time ago, but is now the new official egghead.io Look&Feel.
To avoid confusion and one extra click I just directly point to the new link.

@codecov
Copy link

codecov bot commented Jul 14, 2021

Codecov Report

Merging #932 (97b5a99) into main (6e6bf85) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##              main      #932   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines          140       140           
  Branches        26        26           
=========================================
  Hits           140       140           

Continue to review full report at Codecov.

Legend - Click here to learn more
螖 = absolute <relative> (impact), 酶 = not affected, ? = missing data
Powered by Codecov. Last update 6e6bf85...97b5a99. Read the comment docs.

@nickmccurdy nickmccurdy merged commit 801edaa into testing-library:main Jul 15, 2021
@nickmccurdy
Copy link
Member

@all-contributors add @leschdom for docs

@allcontributors
Copy link
Contributor

@nickmccurdy

I've put up a pull request to add @leschdom! 馃帀

@leschdom leschdom deleted the feature/update-contributing-documentation branch July 15, 2021 06:27
eps1lon pushed a commit to eps1lon/react-testing-library that referenced this pull request Sep 5, 2021
* docs(CONTRIBUTING): update links

... the old egghead.io link redirects to https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github
which displays "We've got a new version of egghead in BETA. Click here
to try it!"

remove obsolete all-contributors link (was removed in 29aad25)

* docs: use consistent spelling for TypeScript

... inspired by https://effectivetypescript.com/2021/02/03/pet-peeves/

Co-authored-by: Matan Borenkraout <Matanbobi@gmail.com>
@github-actions
Copy link

馃帀 This PR is included in version 12.1.0 馃帀

The release is available on:

Your semantic-release bot 馃摝馃殌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants