[
http://jira.jboss.com/jira/browse/RF-2586?page=comments#action_12410198 ]
Svetlana mukhina commented on RF-2586:
--------------------------------------
add the following notes (you could paraphrase them for better understanding ) to this
template:
- copy-past from spec is not allowed
- any changes in the build should be checked before commit, the build must be buildable
- use jira as informational resource, if you have some linked issues to your task, look at
them, also you could run over dev issues of the component or attributes you're
working on
- check code samples before inserting them to guide, code samples in guide must work
- when addressing a developer a question, make sure the question is particular and
understandable
- read some manual on Subversion
- specification is not the only and the best source of component description, check it
with your mind and component implementation
- understand your every written sentence
- avoid time-consuming researches when describing a component, first write a whole
description of it and only then start investigating related topics
Template for component description
-----------------------------------
Key: RF-2586
URL:
http://jira.jboss.com/jira/browse/RF-2586
Project: RichFaces
Issue Type: Task
Components: doc
Affects Versions: 3.2.0
Reporter: Svetlana mukhina
Assigned To: Michael Sorokin
Fix For: 3.2.1
Attachments: RF-2586 Template for component description.zip
Crete a template for components description to use by RF doc team
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.jboss.com/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira