mirror of
https://github.com/EiffelSoftware/eiffel-org.git
synced 2025-12-07 15:22:31 +01:00
bcb550d523
Author:halw Date:2010-03-17T17:47:12.000000Z git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@527 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
45 lines
3.9 KiB
Plaintext
45 lines
3.9 KiB
Plaintext
[[Property:title|Community]]
|
|
[[Property:weight|2]]
|
|
[[Property:uuid|75c75712-7c3e-2757-51b7-77b404471e2e]]
|
|
==You can become a contributor!==
|
|
|
|
Eiffel is a community. Members of the Eiffel community can contribute to this documentation through this book.
|
|
|
|
EiffelStudio documentation is available in a convenient Wiki format. This makes it possible to improve the documentation continuously and make sure it is always up to date.
|
|
|
|
Community input is welcome.
|
|
|
|
===Using the Talk pages===
|
|
|
|
Each documentation page has an associated '''Talk''' page. Any viewer can add comments to a Talk page. These comments are periodically reviewed and appropriate content is "published," that is, made visible to the community.
|
|
|
|
====Guidelines for Talk pages====
|
|
|
|
#The '''Talk''' pages are intended to be used to record and communicate issues concerning the documentation. Use Talk pages to post comments which report problems with the documentation or which suggest improvements to the documentation.
|
|
# '''Any material you add to this site becomes the property of Eiffel Software, and may be shared with the community.'''
|
|
# Talk 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].
|
|
|
|
===Contributors and Editors===
|
|
|
|
If you are interested in a more active role in improving and developing EiffelStudio documentation, you can become:
|
|
|
|
* A contributor: authorized to edit existing pages to any book, and to add pages to the "Community" book.
|
|
**"Community" book pages can be added to other books by an editor.
|
|
|
|
* An editor: authorized to modify and add pages in any book.
|
|
|
|
To become a contributor, you should be proficient in Eiffel technology and have good written English skills. To become an editor, you should already be a contributor and have contributed significant improvements or additions to the documentation.
|
|
|
|
If you are interested in becoming a contributor, you can [[path:user/register|register]] for an account, and then please [[path:contact|contact us]] with a short description of your Eiffel experience and any other relevant background.
|
|
|
|
====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.
|
|
## 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.
|
|
# '''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.
|
|
|
|
|
|
|
|
|