Skip to content

SFG Post Submission Checklist

Jump to bottom
Simanta Sarma edited this page May 22, 2019 · 9 revisions

Item 1: Check Headings

Ensure headings are structured with HTML semantic heading tags. In a post, the title goes in

heading. So your post content is structured starting from

. Ensure all headings are in title case.

Item 2: Check Inline Code

Ensure all inline code are properly formatted. Inline code language should Be Java and the theme should be Git.
You can click the inline code and then select the Code Settings button. In the Code Settings dialog box, select Java from the Language drop-down list and Git from the Theme drop-down list. And then click OK. The generated code (that you can check by clicking Text (HTML)) should be. <code class="EnlighterJSRAW" data-enlighter-language="java" data-enlighter-theme="git">Im inline Code</code>

Item 3: Check Block Code

Ensure all code blocks are properly formatted. Block code language should Be Java and the theme should be Git. You can click the code block, and click the edit icon in the code window. In the Code Settings dialog box, select Java from the Language drop-down list and Git from the Theme drop-down list. Ensure Show Linenumbers check box is selected. And then click OK. The generated code (that you can check by clicking Text (HTML)) should be. <pre class="EnlighterJSRAW" data-enlighter-language="java" data-enlighter-theme="git">Your Block Code</pre>

Item 4: Check for Acronyms

Acronyms should be spelled out at the first instance. Example: MVC (Model View Controller)

Item 5: Check for Lead-in Lines

Ensure all code snippets, images, lists, tables, and so on have a lead in line indicating the objective of the item.
Examples:

  • The code of the controller class is this.
  • This Figure shows the architecture of Spring MVC.
  • The components of MVC are:
  • This table explains the difference between Spring and Java EE.

Item 5: Check for Explanations

Check that code snippet are adequately explained. The explanation should come after the code snippet. For code snippets, Feel free to refer to line numbers. The same holds true for images.

Item 5: Check for Lengthy Sentences

Break lengthy sentences and break into smaller concise sentences.

Non Example This service class will be invoked when the spring boot application runs and the logic which is written using the @PostConstruct will be executed where it will load the data of Books into our HSQL database first which can be queried later by the front-end applications.

Example When the spring boot application runs, the Spring Framework calls the @PostConstruct method. The code inside the @PostConstruct method loads the data of books into the HSQL database.

Item 6: Links to Resources

Provide relevant Cross-links pointing to existing Spring Framework Guru Blogs or external content.
Ensure all links open in a new tab. To do so, click on the link, and then click the Edit button, and then Link options. In the dialog box that appears, ensure that the Open link in a new tab checkbox is selected.

Item 7: Grammarly Check

Install "Grammarly for Chrome" to fix any typos, grammatical errors, phrasing errors.

Finally

Do a Thorough readthrough.

Clone this wiki locally