mirrors/eiffel-org
1
0
Fork 0
mirror of https://github.com/EiffelSoftware/eiffel-org.git synced 2025-12-07 15:22:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Author:halw

Browse Source 
Date:2011-01-18T22:54:04.000000Z


git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@740 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
halw
2011-01-19 15:35:07 +00:00
parent 9441e6df66
commit 652e85bf78
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
documentation/current/community/index.wiki
View File

@@ -19,7 +19,7 @@ Each documentation page has an associated '''Comments''' page. Any viewer can ad
# '''Any material you add to this site becomes the property of Eiffel Software, and may be shared with the community.''' # '''Any material you add to this site becomes the property of Eiffel Software, and may be shared with the community.'''
# Comments pages should ''not'' be used for product support questions, product feature requests, or bug reports. ''Comments of this sort will be deleted.'' For help with products join the [http://eiffel.com/developers/usergroup.html Eiffel Software User Group] and use the resources at the [http://community.eiffel.com Eiffel Community site]. # Comments pages should ''not'' be used for product support questions, product feature requests, or bug reports. ''Comments of this sort will be deleted.'' For help with products join the [http://eiffel.com/developers/usergroup.html Eiffel Software User Group] and use the resources at the [http://community.eiffel.com Eiffel Community site].
=====Comment lifecycle===== ====Comment lifecycle====
Although the procedure for how editors deal with comments is flexible, some general guidelines can be given: Although the procedure for how editors deal with comments is flexible, some general guidelines can be given:
@@ -33,7 +33,7 @@ Although the procedure for how editors deal with comments is flexible, some gene
### A response to the comment will be made via "reply", and ### A response to the comment will be made via "reply", and
#### The original comment's subject line will be prepended with: #### The original comment's subject line will be prepended with:
##### FIXED, if and when the request can be satisfied. ##### FIXED, if and when the request can be satisfied.
##### ANALYZED, otherwise, plus explanation of delayed or not acting on request. ##### ANALYZED, otherwise, plus explanation of delaying or not acting on request.
## For actions affecting docs.eiffel.com plus the Eiffel distribution: ## For actions affecting docs.eiffel.com plus the Eiffel distribution:
### Submit a problem report requesting feedback when problem is fixed so that docs.eiffel.com can be updated in kind. ### Submit a problem report requesting feedback when problem is fixed so that docs.eiffel.com can be updated in kind.
# For comments not requesting action, but adding relevant information related to the page: # For comments not requesting action, but adding relevant information related to the page:
@@ -58,7 +58,7 @@ If you are interested in becoming a contributor, you can [[path:user/register|re
====Guidelines for contributors==== ====Guidelines for contributors====
# '''Entering log messages:''' When you change pages in the documentation, it can help sometimes if you can provide an explanation of your intent in the '''Log message''' box on the '''Edit''' page. This can eliminate confusion about why things have been changed. Of course, it is not necessary to provide a log message for every change. For fixing typographical errors or other simple changes, it generally would not be necessary. Likewise, if you are evolving new pages or a complex set of related changes to one or more pages, it should suffice to enter a single log message at the beginning of the series of edits. Use common sense here. # '''Entering log messages:''' When you change pages in the documentation, it can help sometimes if you can provide an explanation of your intent in the '''Log message''' box on the '''Edit''' page. This can eliminate confusion about why things have been changed. Of course, it is not necessary to provide a log message for every change. For fixing typographical errors or other simple changes, it generally would not be necessary, but putting a single lowercase '''"m"''' in the '''Log message''' field will convey the message that this was a minor update. If you are evolving new pages or a complex set of related changes to one or more pages, it should suffice to enter a single log message at the beginning of the series of edits. Use common sense here.
## In cases in which a change is directly related to an external document or policy, it may be helpful to mention the impetus in the log message. For example, documentation changes made to satisfy Eiffel Software problem reports should reference the report in the log message. ## In cases in which a change is directly related to an external document or policy, it may be helpful to mention the impetus in the log message. For example, documentation changes made to satisfy Eiffel Software problem reports should reference the report in the log message.
# '''Renaming pages or moving pages to Trash:''' Before you rename a page or move it to the Trash, you should use the '''References''' tab to make certain that there are no current references to the page. If there are, make sure you resolve those references before renaming or moving the page. # '''Renaming pages or moving pages to Trash:''' Before you rename a page or move it to the Trash, you should use the '''References''' tab to make certain that there are no current references to the page. If there are, make sure you resolve those references before renaming or moving the page.
# '''Replacing pages:''' If you need to replace a page completely, do so by replacing the '''content''' of the existing page, rather than moving the page to the Trash and creating a new page in its place. Replacing the content will leave the original page (and its UUID) in place, but with the new content. UUID's are used by the [[Eiffel Information System]] (EIS) to link EiffelStudio to documentation pages, and will be broken if the original page were to be deleted. # '''Replacing pages:''' If you need to replace a page completely, do so by replacing the '''content''' of the existing page, rather than moving the page to the Trash and creating a new page in its place. Replacing the content will leave the original page (and its UUID) in place, but with the new content. UUID's are used by the [[Eiffel Information System]] (EIS) to link EiffelStudio to documentation pages, and will be broken if the original page were to be deleted.