We encourage all new contributors to go over our new contributor folder which has a list of resources to prepare to submit a new topic and article idea. We also suggest to review the most recently published articles to avoid topic overlap (and to get a good sense on article style tonality, and quality that we are accepting) submit a topic using this issue form.
To suggest a (potential) EngEd feature suggestion fill this form out.
Visit our step-by-step guide on how to upload your 1st EngEd article to the GitHub repo.
Here is a link to a short video further explaining what a pull request is.
Here is a link to a short video further explaining what a pull request is and how to fork a Github repository.
Include a short Author Biography (index.md file) and Headshot image (avatar file). Include these files in the authors folder within the GitHub repo via your forked repo similar to the article files. We want to credit you for your hard work.
Use this every time before contributing a new article to keep it up to date git fetch section
git pull --rebase section master
git push origin
This should help prevent any merge conflicts.
For more details on how to submit a PR check out our contribution guidelines here.
Yes, please refer to our upload instructions for a step-by-step guide on how to include YT videos into your articles.
The only requirement is that the article has to be at least 750 words, there is no upper cap limit as we want to ensure we are providing value to the EngEd community and the developer audience at large.
Articles should be a minimum of 750 words.
Articles with (little to no extra revisions needed) will recieve priorty in the queue.
For the full details on our review, approval, & payment processes check out the provided link.
A tutorial is a walk-through implementation on a topic. For example: How to set up Ubuntu on Linux. Steps laid out, with screenshots, and accompanying snippets. An article is a piece describing, explaining, or exploring a topic (with out any steps on HOW TO implement). For example - The Difference between Java and C++.
Any extra (major) steps that take a reviewer away from the actual revision process (revising, editing, and proofreading) and causes a shift towards content creation. Any (major) incorrect code snippets (all code should be tested - contributors should take advantage of free tools such as repl.it). Instances when the content is too difficult to understand. PRs that may lack sufficient unique* value - (any and all comments made by reviewers to draw out more value from the article are great and encouraged but should be limited) *by unique we mean content that can NOT simply be found by looking up the official documentation.
Use your EngEd community as a resource - get to know each other and ask for a revision from a fellow contributor before submitting a final draft.
Please do not hesitate to reach out at any time - we’re always happy to help.
For the Content Stewards (Peer Review Program) we typically look for authors who have contributed a few articles (so that they are familiar with the article submission process) and can guide new contributors along the way.
Most importantly we look for authors who have demonstrated great technical acumen, overall attention to detail (grammar, formatting, etc.), and community engagement.
The position is a compensated position - 50 USD per successful article review.
We always encourage friendly reviews among the community to help each other out before article submission. Verified Peer Reviewers are paid $50.00 USD per successful article revision.
No. The value that the EngEd program is providing to students is that of career building, skill enrichments, community building, and portfolio that can be referenced and leveraged upon entering the workforce.
We will look over the all articles that come in to ensure they are publish worthy - but our peer reviewer team is only looking to improve the content by making suggestions. For revisions services we recommend using a few of the services we have vetted - both economical and professional.
We ask that if you would like to repost your Section work elsewhere, that new work reference the original Section (EngEd) article. Adding a rel=canonical tag is the preferred path forward. This does not mean that published work on EngEd can be previosly published elsewhere - we still ask for original and unique work.
After you have published your article with us - be sure to check on your content periodically to respond to any comments or questions that the audience may post. Please sign up with HyvorTalk to reply to any comments or questions left on your articles.