Article checklist

Attention

Our Peer Reviewer and Content Moderator teams do NOT provide any revisions services. All revisions and edits should be completed on your own forked repo (as to not take up room in the queue) in order for our team to review them all in a timely manner.

ANY ARTICLE SUBMITTED WITH GLARING ERRORS WILL BE IMMEDIATELY CLOSED.

As a rule of thumb - please be sure to only submit articles (pull requests) that are fully polished and ready to be published. Be sure to go through our resources documents for extra and 3rd party (vetted) resources to help improve overall technical writing.

Pre-submission checks

Please ensure that you have only one open topic suggestion (issue) + in-review article (linked pull request) at a time. This will ensure that we complete the review process in a timely manner from inception to publishing

If you have not already, please go over our Resources Page for more tips and tricks on how to improve your overall technical writing so reviews are swifter, increase the chance of a payout and provide more value to our readers.

For first-time contributors and for more details on our submission guidelines, see our Contributing Guidelines.

Formatting and structure checks

• Have you used the correct folder and file structure? - see Contribution Guidelines

• Is your article properly formatted in Markdown? - see Github Markdown guide

• Have you used our preferred heading structure? - H3 (###) and up

• Does your article follow any of the suggested structure formats? - see example formats

• Is your article over 750 words? - Tool: Wordcounter.net

• Is the article you are submitting an in-depth and unique article? Does it go beyond what is in the official docs and what is covered in other blog sites. See these articles as examples.

• Does your article provide enough value and detail about your topic? - Articles should be clear, accurate, and fully explained.

• Can your article be understood by beginners? - Assume the audience is smart but has no prior exposure to the common terminology in your article.

• Have you included a hero image that is 600x400 pixels, under 300KB in size, and have the copyright to use it? - Tools: Pixlr Image Editor for resizing and Unsplash for Creative Commons images

Grammar & plagiarism checks

• Have you spellchecked and grammar checked your article? - Tools: Write&Improve - ProWritingAid - Grammarly
• Please place your article through a 3rd party plagiarism checker. We suggest using Quetext, this tool is free and has a daily limit. We typically accept articles with 10% or less.
• Have you checked your article for readability? - Tool: Hemmingway
• Have you added sources for quotes and images that aren't yours?

Technical checks

• Are your code snippets properly formatted for syntax highlighting - see Syntax guide
• Have you checked your code runs correctly and you've highlighted all necessary dependencies for installation?
• Are the software programs and packages you're highlighting in your article up to date, using current versions and not deprecated?

Topic suggestion this closes

Remove the backticks and add the issue number below to link and close your Topic Suggestion (issue) when your article has been published (PR has been merged). See this video for more details.

This closes #issue-number

Finally, delete the article checklist notes in blockquotes and submit your PR. We look forward to reviewing your article.