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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md for Ember Times #910

Merged
merged 2 commits into from
Feb 14, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,33 @@ If you have questions or need help with writing, please visit the `#dev-ember-le

1. We use [alex](https://alexjs.com/) and [markdownlint](https://github.com/DavidAnson/markdownlint) for linting. If your branch's CI (continuous integration) didn't pass these linters, please consider rewording or updating Markdown syntax to fix the error. If the linter incorrectly marked something as an error, you may add an exception to your file.

* If GitHub Actions lint CI fails on alex, the failure is usually listed **far** above `Exit status 1`.

```
⚠ 1 warning
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! ember-blog@0.0.0 lint:alex: `alex {content,post-templates}/**/*.md`
npm ERR! Exit status 1
```

Search for "warning" to see the specific alex failure, which will look like:

```
content/the-ember-times-issue-173.md
71:8-71:12 warning Don’t use `Tang`, it’s profane tang retext-profanities
```

* If GitHub Actions lint CI fails on markdownlint, the failure is usually listed **closely** above `Exit status 1`. In the example below, the markdownlint error is `MD034`. Full list of rules can be found [here](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md).

```
content/the-ember-times-issue-173.md:39:16 MD034/no-bare-urls Bare URL used [Context: "https://dev.to/jelhan/format-g..."]
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! ember-blog@0.0.0 lint:md: `markdownlint {content,post-templates}/**/*.md`
npm ERR! Exit status 1
```

</details>


Expand Down Expand Up @@ -148,25 +175,30 @@ Thank you for contributing to The Ember Times! Let us know if you can be a guest

<details>
<summary>Substack instructions</summary>

1. Get a login to the Ember Times account on Substack from [#support-ember-times](https://discord.com/channels/480462759797063690/485450546887786506).
1. Merge post PR to master on this repo.
1. Draft a new post in Substack. From https://github.com/ember-learn/ember-blog/find/master, search for the issue e.g. "171".
1. Copy the copy content of the blog from there into Substack. You will need to manually import images such as Office Hours Tomster mascot https://github.com/ember-learn/ember-blog/blob/master/public/images/tomsters/officehours.png.
1. Manually import ember_E-icon-4c-Rounded-Rectangle.png for the Substack social preview.
1. Send to the list!

</details>

<details>
<summary>Twitter instructions</summary>

1. Post tweet on Tweetdeck to post on Monday (second day of #engagement)
1. Set $natural reminder on Discord, for example: 1$natural on December 23th at 2:00pm send post tweet 2 news & announce @Alon (if you're avail!) :newspaper2: to #support-ember-times`
1. Use one emoji for each line item as a bullet point
1. Try to @ or hashtag when appropriate
1. Include the URL to the blog

</details>

<details>
<summary>dev.to instructions</summary>

1. Copy raw from GitHub, delete top YAML portion.
1. If they appear in the preview, delete any `alex-ignore` or `markdownlint-ignore`.
1. Delete any italics classes such as <span style="font-style: italic;"></span>. Normal <em> or *italicizeme* markdown doesn't work in /ember-blog right now.
Expand All @@ -175,4 +207,5 @@ Thank you for contributing to The Ember Times! Let us know if you can be a guest
1. Add canonical URL and series name (The Ember Times should come up)
1. Add body image for Readers' Questions image manually https://github.com/ember-learn/ember-website/blob/master/public/images/tomsters/officehours.png.
1. Format manually if needed.

</details>