You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

CONTRIBUTING.md 925 B

1234567891011121314151617181920212223242526272829303132333435
  1. # Contributing to Docs
  2. ## General Guidelines
  3. We do not have any strict conditions for writing documentation,
  4. but keep these guidelines in mind:
  5. * Keep code samples in the `guides/samples` folder
  6. * When referencing an object in the API, link to its page in the
  7. API documentation
  8. * Documentation should be written in an FAQ/Wiki-style format
  9. * Documentation should be written in clear and proper English*
  10. \* If anyone is interested in translating documentation into other
  11. languages, please open an issue or contact me on
  12. Discord (`foxbot#0282`).
  13. ## Style Consistencies
  14. * Use a ruler set at 70 characters
  15. * Links should use long syntax
  16. * Pages should be short and concise, not broad and long
  17. Example of long link syntax:
  18. ```md
  19. Please consult the [API Documentation] for more information.
  20. [API Documentation]: xref:System.String
  21. ```
  22. ## Recommended Reads
  23. * http://docs.microsoft.com
  24. * http://flask.pocoo.org/docs/0.12/