Home

How to Contribute

If you're familiar with Git and Markdown, please follow our Contribution guide.

How to contribute without knowledge of Git or Markdown

You can contribute to Knowledgebase with an article. DX Knowledgebase has two possible types of articles - problems (that you have encountered) and practices (the best method to overcome problems).

How to compose an article

1. Ask for or propose an article topic via email at dev@dxheroes.io
2. Name your article
3. Write an article. Feel free to use your favorite text editor.
4. Submit your article at dev@dxheroes.io

Tips on How to Write your Article

• Use the active voice when possible
• Establish a clear structure and try to be precise
• Be brief, clear, and direct
  • Important information in the main clause
• Simplify your language
• Avoid jargon and abbreviations
  • Define acronyms and initialism on their first use - give the abbreviation in parentheses after the full terminology
• Use a grammar check tool, for example:
  • Grammarly
  • Microsoft Word Spelling and Grammar with the Readability Measurement

Article Sections

For Practice:

• TL;DR
• What Is a %{name}
• Why You Might Want the %{name}
• Problems the %{name} Helps to Solve
• How to Implement the %{name}?
• Common Pitfalls of the %{name}
• Resources for the %{name}

For Problems:

• TL;DR
• What Is a %{name}
• Reasons for %{name}
• Practices solving the %{name}
• Resources for %{name}