Some rules when contributing to the site.
Write in a professional, but friendly and approachable manner. Do not be condescending or standoffish. Do not swear and do not use terms like "lol" or "roflcopter".
Articles should be more than 500 words. Smaller articles can be created as snippets that should be no longer than 500 words.
There is currently no fixed upper limit to article length, but splitting the article into parts is encouraged for really long topics. You can relate posts together in the admin interface.
Introduce the article with a short description. This allows some text to be moved into the introduction field, which can then be posted to social media sites.
Try to create a narrative around the article. It should have an introduction and a conclusion and should take a reader through the steps to understand the topic.
Don't just repeat the documentation of a package, try to do something different or expand on it in some way.
Linking to original sources is perfectly fine to do, the only stipulation is to use accessibility best practices with the links. In other words, the text of the link should describe what the link goes to, it shouldn't use terms like "click here" or "see this page".
Code examples are good, and are encouraged, but don't just paste 1,000 lines of code into the article. Pick out the salient points and describe them. Try to reach a compromise between code and explanation of the code.
If not all of the code fits then create a git repository with the full source code and link to that in the article. We have a GitHub resource you can use for this.
The code should be formatted correctly.
The code should not contain any errors and should never contain security flaws unless explicitly stated either in the code itself or in the explanation text.
Unless it fits the narrative of the article, do not use specific module names or user names. Instead use names like "my_module" or "my_user" as place holders.
To keep consistent with the branding of the site use the term "article" to refer to other articles on the site. Do not use terms like "blog" or "post".
Please use the oxford comma format when listing items.
Images are fine to use, but they should be resized before uploading. No wider or higher than 1000px. Images should be resized and reduced to reduce their size. Saving the image as a PNG and using image size reduction services like TinyPNG is a must to reduce the footprint of the image.
If you want to write the name of the site then we are either the domain "www.hashbangcode.com" or "!# code", with a space between the "#" and the "code". You might find us as "Hash Bang Code" on external sites, but that is because those sites do not allow "#! code" as a site name or, we want to explicitly state what the site is called so that people can link the logo with the brand.