Update CONTRIBUTING.md #33523
Update CONTRIBUTING.md #33523
Conversation
| 4. Click the edit (pencil) button | ||
|
|
||
| From there, the GitHub UI will walk you through the rest by creating a [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) and a branch to commit your changes to. | ||
| After you have made changes to your branch, the goal is to open a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) for your changes to be incorporated. | ||
| After you have made changes to your branch, open a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) with your changes to be incorporated. | ||
|
|
||
| A pull request represents the work you want to be reviewed, approved, and merged into the `main` branch of the MDN repository. | ||
| See the [Creating a pull request](#creating-a-pull-request) for more details on creating and handling pull requests successfully. |
There was a problem hiding this comment.
on the next line, the href if empty
There was a problem hiding this comment.
@estelle I fixed and then un-fixed this. This is a reference link - so the definitions are done at the bottom of the page.
@dipikabh / @bsmth While this reference works, it is deprecated by tools such as prettier, because as an editor it is hard to tell if the link is omitted or satisfied by a later reference. Generally they look great, but they make the doc hard to read.
Prettier formats for this case to [get in touch with us][get in touch with us], and I tend to use shorter references, so I'd have something like [get in touch with us][get_in_touch].
I'm not advocating this - I think reference links should only be used if you have like 3 instances of a link in a page. Otherwise use normal links. And if you have to use a reference link, use the prettier format
There was a problem hiding this comment.
PS note some links are broken - specifically those on line 13 as the use this format: - [Writing guidelines][]. They'd work if you instead had - [Writing guidelines]. Not fixing, as I want some discussion of ^^^
There was a problem hiding this comment.
The reason for using the reference style links here is for Markdownlint to catch links in this format in the rest of content:
see [this page](https://developer.mozilla.org/en-US/docs/Web/JavaScript)And correct it to:
see [this page](/en-US/docs/Web/JavaScript)This is fine everywhere else, but breaks in the .md files intended to be read on GitHub. As a workaround, we use this format:
See the [JavaScript landing page][] for more info...
[javascript landing page]: https://developer.mozilla.org/en-US/docs/Web/JavaScriptThis was introduced here:
https://github.com/mdn/content/pull/21432/files
links are broken - specifically those on line 13 as the use this format
[Writing guidelines][]
It looks weird, but it works okay: https://github.com/mdn/content/blob/main/CONTRIBUTING.md#getting-started
Here's the spec for this "shortcut reference link" syntax: https://github.github.com/gfm/#shortcut-reference-link (ex 575)
github-actions
bot
added
size/s
There was a problem hiding this comment.
Approving, but see https://github.com/mdn/content/pull/33523/files#r1596079745 - "reference links suck and there are still some reference link bugs".
|
I reverted my [] removal, but kept the grammar changes that were approved. |
If someone doesn't read the intro, and just scans the bullets, the javascript file seemed odd. Added a bit of text in case someone does that (people tend to read bullets, not prose, so it's likely.
Please add a link on link 85 - the url is missing in the href.