Difference between revisions of "Guidelines for contributing to COPTR"

From COPTR
Jump to navigation Jump to search
(Created page with "* Keep COPTR entries concise and factual. User feedback and other comment should go elsewhere (eg. a blog post) and be referenced with a hotlink. * Avoid time specific languag...")
 
Line 1: Line 1:
* Keep COPTR entries concise and factual. User feedback and other comment should go elsewhere (eg. a blog post) and be referenced with a hotlink.
+
* Keep COPTR entries concise and factual. User feedback and other subjective comment should go elsewhere (eg. a blog post) and be referenced with a hotlink from the "User Experiences" section.
* Avoid time specific language as it will quickly become out of date. For example avoid: "The current version of the tool...", "This is a new tool", "This tool is currently under development". Try instead to be specific and reference a specific tool version and/or date.
+
* Avoid time specific language as it will quickly become out of date. For example avoid: "The current version of the tool...", "This is a new tool", "This tool is currently under development". Try instead to be specific and reference a particular tool version and/or date.
 
* Choose categories (tags) for a new tool page carefully. Make use of existing categories and avoid adding lots of unnecessary tags.
 
* Choose categories (tags) for a new tool page carefully. Make use of existing categories and avoid adding lots of unnecessary tags.
 
* Search carefully for existing entries before adding a new tool entry. Ensure you don't add a duplicate entry by first searching for existing entries for the tool you want to add. If there is already an entry, make it better!
 
* Search carefully for existing entries before adding a new tool entry. Ensure you don't add a duplicate entry by first searching for existing entries for the tool you want to add. If there is already an entry, make it better!
 
* Please don't change the structure of your new tool entry, as this will damage export from COPTR. If you have feedback on the existing structure, please let us know.
 
* Please don't change the structure of your new tool entry, as this will damage export from COPTR. If you have feedback on the existing structure, please let us know.

Revision as of 11:54, 13 November 2013

  • Keep COPTR entries concise and factual. User feedback and other subjective comment should go elsewhere (eg. a blog post) and be referenced with a hotlink from the "User Experiences" section.
  • Avoid time specific language as it will quickly become out of date. For example avoid: "The current version of the tool...", "This is a new tool", "This tool is currently under development". Try instead to be specific and reference a particular tool version and/or date.
  • Choose categories (tags) for a new tool page carefully. Make use of existing categories and avoid adding lots of unnecessary tags.
  • Search carefully for existing entries before adding a new tool entry. Ensure you don't add a duplicate entry by first searching for existing entries for the tool you want to add. If there is already an entry, make it better!
  • Please don't change the structure of your new tool entry, as this will damage export from COPTR. If you have feedback on the existing structure, please let us know.