Help:Editing

The Corepunk wiki strives for a comprehensive archive of information about the videogame Corepunk. As such, it allows anybody to contribute, no matter how big or small the contribution. You do not need to register to contribute to the wiki. If you don't register, your edits will be publicly linked to your IP address.

General

Important editing guidelines. Anyone editing the wiki should familiarize themselves with these rules.

Content

If a page is long, a summary section containing key information should be written at the top of the page.
Content should be written in American English, in an unbiased, formal manner. They should be as concise as possible whilst still being readable to most users and without loss of information. Content should be relevant and should not be a narrative short story.

Appearance

Editors must ensure articles have a consistent and standardized appearance. This is done through the use of templates.
We aim for a visual style similar to that of Corepunk's official website, but without outright plaigarism.

Uploading

All images, with the exception of icons, should be uploaded as .jpg files. This makes load times for pages with many images significantly faster.
Icons should be uploaded as .png files with the highest resolution possible. This tends to be around 200x200px for Item icons and 100x100px for Stat icons.
When taking screenshots, ensure the image quality is the highest possible before compressing. This means all graphics settings should be set to their maximum values.
All files must have the correct license attributed to it, and editors must use the file in accordance with the license.

Sourcing

See: Copyrights

Content on the Corepunk Wiki must be properly sourced, with copyrighted images as a priority. Copyrighted images must be used such that they qualify under fair use (i.e. these images must be used for educational purposes).

Edits

Upon submitting an edit, users can mark it as either a Minor Edit or a Major Edit. Additionally, users can use to update pages.

Minor Edits

A minor edit signifies that a small, superficial change has been made to the previous version. This may include, but is not limited to: fixing typos, spelling and/or grammatical mistakes; altering page appearance and/or structure; updating inaccurate information; or addition of detail that is of little importance to the overall article.

To signify a minor edit, tick the checkbox labeled "This is a minor edit" above the "Save changes" button. Summaries provide an at-a-glance summary of what changed about an article. Marking an edit as minor does not mean the contributor should forgo writing an edit summary. Editors should not feel that marking an edit as minor devalues their contribution in any way.

Major Edits

Major edits are edits not considered to be minor. Editors should first consider adding to to the relevant talk page and getting consent from relevant editors first before making the contribution. If an edit takes place over an extended period, consider saving the page and using the {{in use}} template to prevent edit conflicts and ensure progress isn't lost if the broswer crashes.

Dummy Edits

Dummy edits are changes to a page's wikitext that have no effect on the rendered page. They are useful for updating templates used on a page or any uploaded images.
To perform a dummy edit, users can:

remove the newline character at the bottom of the text.

add a comment.

Article Creation

Before article creation, ensure that it is necessary and relevant to Corepunk. Novice editors are reccommended to begin with smaller edits first before creating a new article.

Talk Pages

Talk pages are used to discuss possible changes to a particular article before it becomes a submitted contribution. If an editor is unsure about a contribution, it is reccommended to ask in the article in question's related talk page.
Editors should sign their contributions to a talk page with their signature with four tildes (i.e. "~~~~")

Documentation

We strive for a wiki such that the average user can look at our source and understand its general function.
In general, a page's source should be documented with comments if it is hard to read and/or understand. This means all code that isn't self-explanatory should be commented.

Naming Conventions

Pages and headings should be named formally, concisely and sensibly. It should convey a general idea of what the section is about.

Templates

Templates are snippets of wikitext to be included in articles. It is similar to a class in object-oriented programming.
They are used by this wiki as a means of standardization and ease of use. In general, if a snippet is repeated across multiple pages, it should be abstracted into a template.
Comments in templates should be adjacent to the line it is commenting on, or directly above the relevant section.

All templates should be documented with the following headings (if necessary):

Description (required)

Usage (required, using the {{T}} template)

Parameters (using the {{parameter}} template)

Template-Specific Headings (for clarity)

Errors (any and all usages of {{error}} should be documented here)