DRAFT |
Contributing
We are very pleased that you are interested in contributing! Here's what you need to know:
Due to spammers, write access to this wiki is disabled by default. If you haven't already, please email your wiki username and the type(s) of edits you would like to make to <ANTI SPAM wiki AT libsdl DOT org> to be given write access and to coordinate efforts.
Thank you!
Our goal is to create the best documentation for SDL possible. To this end we have adopted the following guiding principles and would appreciate your keeping them in mind as you create your contributions.
- This wiki should:
- have a consistent look and feel throughout
- be easy to use
- be accurate
- contain high quality information
- be as simple and straight forward as possible
To help you with this we have created a series of resources.
Resources
Feedback Form
Every page of the wiki contains a drop down Feedback form (upper right) where you can post quick content ideas, questions, suggestions, etc. Simply click the form tab, fill in the text field with your contribution, and click Submit. We'll take it from there!
Mailing List
The Documentation Mailing List has been set up to allow users to discuss documentation-related topics. Anything from content to conventions, questions and comments can be shared in the Mailing List. Plus, keep up with what others are saying and doing on the wiki.
We encourage all contributors to join the mailing list and participate in the discussions there. It is a great place to discuss areas that need contributions and to let others know what you are working on or if you are able to help address a request.
Style Guides by Topic
These are the core of our contribution resources. There is a style guide for each type of contribution you may wish to make. Please review the relevant one(s) before you begin to edit and check back periodically for updates.
Table with links to each style guide |
Basic description of SG contents |
quick reference for wiki markup used in this wiki |
|
information on adding Code Examples to any API page |
|
information on adding Remarks to any API page |
|
information on adding a tutorial to the tutorials page |
It is very important to us that this wiki remains as friendly and professional as possible. We have created detailed style guides to help you ensure that your contributions fit in seamlessly and help to make the wiki that much better for other users.
If you find something that is not addressed or is unclear in a style guide please post your questions using the feedback form, on the mailing list, or email us at <ANTI SPAM wiki AT libsdl DOT org>.
Email Contact
For anything that is not addressed in the above you can always send an email to <ANTI SPAM wiki AT libsdl DOT org>.
Disclaimer
All content modifications are subject to review for consistency and quality. We reserve the right to remove or modify any content added to this wiki at any time. You may direct questions or concerns to <ANTI SPAM wiki AT libsdl DOT org>.
