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.

Sign up for GitHub

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

Jump to bottom

adding several guideline updates for contributors and reviewers #363

Merged
merged 2 commits into from
Dec 18, 2020
Merged

adding several guideline updates for contributors and reviewers #363

merged 2 commits into from
Dec 18, 2020

Conversation

chrisdavidmills
Copy link
Contributor

I've added a bunch of new guidelines to our contributor and reviewer files:

  • README.md — some instances of "pull-request" changed to "pull request".
  • README.md — "Pull request etiquette" section updated to provide stronger instructions on creating an issue to describe your change first before just submitting a PR, if the intended change is complex.
  • README.md — Added an "Archiving and unarchiving pages" section, as requested.
  • README.md — Add a "Making a change that depends on a macro update" section, as requested.
  • REVIEWING.md — Added a note with helpful information about dealing with merge conflicts.
  • REVIEWING.md — Added "Specific reviewer overrides on pull requests" section to deal with setting specific reviewers for PRs.

Please let me know if you think these look OK.

@chrisdavidmills chrisdavidmills requested a review from a team as a code owner December 17, 2020 16:56
@chrisdavidmills chrisdavidmills requested review from a team and fiji-flo December 17, 2020 16:56
@chrisdavidmills
Copy link
Contributor Author

@escattone @jpmedley @sideshowbarker would love to hear you thoughts.

sideshowbarker
sideshowbarker approved these changes Dec 17, 2020
View reviewed changes
Copy link
Member

@sideshowbarker sideshowbarker left a comment

Choose a reason for hiding this comment

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

Looks great to me content-wise — I don’t have any suggestions for improvements. (Otherwise, just one minor typo fix.)

escattone
escattone approved these changes Dec 17, 2020
View reviewed changes
Copy link
Contributor

@escattone escattone left a comment

Choose a reason for hiding this comment

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

@chrisdavidmills Thank you, these are really nice additions!

@chrisdavidmills chrisdavidmills merged commit a26200b into mdn:main Dec 18, 2020
@chrisdavidmills
Copy link
Contributor Author

Thanks for your input folks!

peterbe
peterbe reviewed Dec 18, 2020
View reviewed changes
README.md
* Find the source code location of the archived page. Archived pages live in the [Archived content](https://github.com/mdn/archived-content/) repo, the structure of which is the same as this repo (except that there are also locale directories present other than `en-US`). As an example:
* Take the archived [Mobile developer challenge](https://developer.mozilla.org/en-US/docs/Mozilla/Mobile/Mobile_developer_challenge) page, which is at the URL `https://developer.mozilla.org/en-US/docs/Mozilla/Mobile/Mobile_developer_challenge`.
* This page's source code is at [https://github.com/mdn/archived-content/blob/main/files/en-us/mozilla/mobile/mobile_developer_challenge/index.html](https://github.com/mdn/archived-content/blob/main/files/en-us/mozilla/mobile/mobile_developer_challenge/index.html).
* To unarchive the page, you need to open a pull request to move the page's directory into the appropriate place inside this repo, and update the page's meta data (like `slug`) if needed.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not accurate. That index.html is actually a product of:

---
FRONT MATTER
---

RENDERED HTML

And in that same folder, there exists a raw.html that is the KS peppered raw HTML, so you'd need to grap the front-matter from the index.html and the raw HTML from the raw.html and combine them. Sorry. :(

I need to help out with the en-us/mozilla/projects/ unarchiving (in that other issue somewhere) and for that I'll use a Python script I have. I guess I need to share that or copy its functionality into the Node tool/cli.js in Yari.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've just seen your comment here @peterbe . How do you want me to update this text?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@peterbe peterbe peterbe left review comments

@sideshowbarker sideshowbarker sideshowbarker approved these changes

@escattone escattone escattone approved these changes

@fiji-flo fiji-flo Awaiting requested review from fiji-flo

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@chrisdavidmills @peterbe @sideshowbarker @escattone