VCMP:Contributing - Revision history

Stormeus at 19:50, 9 March 2016

2016-03-09T19:50:46Z

← Older revision		Revision as of 19:50, 9 March 2016
Line 6:		Line 6:

	* Provide links to functions or callbacks referenced in scripting examples, or other relevant wiki pages.		* Provide links to functions or callbacks referenced in scripting examples, or other relevant wiki pages.
	* Make sure your code is wrapped in <tt><nowiki><source lang=squirrel></source></nowiki></tt> tags.		* Make sure your code is wrapped in <tt><nowiki><source lang=squirrel></source></nowiki></tt> tags. (Lua and D are also good alternatives if you want syntax highlighting.)
	* Explain what the function does at the top of the article, and explain what each parameter is for, even if it seems obvious.		* Explain what the function does at the top of the article, and explain what each parameter is for, even if it seems obvious.
	* Make sure you understand as much as possible what a function does and what parameter it takes in, so as not to mislead readers.		* Make sure you understand as much as possible what a function does and what parameter it takes in, so as not to mislead readers.

Stormeus at 11:03, 9 March 2016

2016-03-09T11:03:05Z

← Older revision		Revision as of 11:03, 9 March 2016
Line 13:		Line 13:

	The wiki is a communal project, and people other than yourself will be editing your contributions as well, for better or worse. When creating a new page, adding a new section, or contributing notes to an article, please '''do not''' sign your name on the page. It creates a feeling of territoriality on the wiki and may discourage people from improving something that you started.		The wiki is a communal project, and people other than yourself will be editing your contributions as well, for better or worse. When creating a new page, adding a new section, or contributing notes to an article, please '''do not''' sign your name on the page. It creates a feeling of territoriality on the wiki and may discourage people from improving something that you started.

			== Consider patrolling edits ==

			You can check the [[Special:RecentChanges\|list of recent changes]] and help your fellow editors by improving contributions to be more in line with these guidelines.

	== Good examples ==		== Good examples ==

Stormeus at 10:54, 9 March 2016

2016-03-09T10:54:51Z

← Older revision		Revision as of 10:54, 9 March 2016
Line 18:		Line 18:
	* [[OnPlayerDeath]] — script event		* [[OnPlayerDeath]] — script event
	* [[Skins]] — ID reference		* [[Skins]] — ID reference

			== Articles in need of attention ==
			* [[:Category:Needs_Description]]
			* [[:Category:Needs_Example]]

Stormeus: Created page with "As a contributor to the wiki, you should make sure that your contributions are of high quality. To ensure this, please refer to these guidelines for editing the wiki. == Form..."

2016-03-09T10:48:23Z

Created page with "As a contributor to the wiki, you should make sure that your contributions are of high quality. To ensure this, please refer to these guidelines for editing the wiki. == Form..."

New page

As a contributor to the wiki, you should make sure that your contributions are of high quality. To ensure this, please refer to these guidelines for editing the wiki.

== Format your articles properly ==

You should be using MediaWiki formatting to split your articles into sections as needed, and to provide rich content to offer more resources. Make sure to read the [https://www.mediawiki.org/wiki/Help:Editing_pages MediaWiki guide] on editing pages, and consider the following tips:

* Provide links to functions or callbacks referenced in scripting examples, or other relevant wiki pages.
* Make sure your code is wrapped in <tt><nowiki><source lang=squirrel></source></nowiki></tt> tags.
* Explain what the function does at the top of the article, and explain what each parameter is for, even if it seems obvious.
* Make sure you understand as much as possible what a function does and what parameter it takes in, so as not to mislead readers.

== Do not sign your edits ==

The wiki is a communal project, and people other than yourself will be editing your contributions as well, for better or worse. When creating a new page, adding a new section, or contributing notes to an article, please '''do not''' sign your name on the page. It creates a feeling of territoriality on the wiki and may discourage people from improving something that you started.

== Good examples ==
* [[Scripting/Squirrel/Functions/InPoly]] — script function
* [[OnPlayerDeath]] — script event
* [[Skins]] — ID reference