Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

47 lines (29 loc) · 2.27 KB

Contributing Guidelines

Posts

The Devs blog is an open source blog where anyone can publish their aricles, provided it follows certain guidelines.

Choosing a subject

  • Make sure the subject you're choosing is interesting and has the potential for high quality content.

  • Since our blog is pretty fresh, try to choose trendy topics on trendy languages, which will attract visitors, in turn helping them discover our community.

  • That said, if you're unsure about your subject, you can open an issue and ask for feedback.

Format

Our blog posts are written in Markdown. Make a copy of post-format.md in the /posts/ folder and start writing!

Post info

If you look at any of our blog posts, you will notice that the first section, called front matter, contains the post information. This section will be omitted from the final article. It includes these fields:

  • title: Post title in the blog.
  • img: Alt name for the article's featured image. (More info in image section)
  • date: Publishing date for your article, in Y, M, D format.
  • author: Name of the article's author (you).
  • cats: Categories, seprated by comma.
  • tags: Tags, seprated by comma.

Images

For the featured image of the article:

  • Image size must be 800x450
  • Image format must be jpg and it should be optimized.
  • Add the image to /static/img/posts.
  • Rename it to match what you entered in the front matter above.

For images you use inside the article, create a folder in the /static/img/posts, add all the images there and reference to that properly.

DO NOT use a copyrighted image, or an image that requires attribution. You can use Unsplash if you need to use stock photos.

Ready to create pull request

Add the post in posts folder. Make sure all images are properly referenced.

Note: If your post needs refining, others have the right to edit the content it is published.