Contribution Guide

From Repair Wiki
Revision as of 10:30, 1 July 2024 by ASRepairs (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Repair Wiki Contribution Guide

Thank you for considering contributing to our Repair Wiki! Your help is invaluable in creating a comprehensive resource for individuals seeking knowledge and guidance on repairing various devices. This contribution guide will walk you through the process of creating a new page as well as filling up stub pages that lack images or details.

Getting Started

  1. Read the Guidelines:
  2. Create an Account:
    • Before you start contributing, you must create an account!. Click on the user icon on the side bar and then click request an account/sign up. Follow the instructions to create your account.
  3. Explore the Wiki:
    • Familiarize yourself with the Repair Wiki by exploring existing pages. Understand the structure and formatting used in articles. All of this is mentioned in the guidelines which is why it's crucial that you take a moment to read them.

Creating New Pages

To create a new page, navigate to the main menu, select the desired page type, pick a suitable title, and finally, click on "Create Page."

Now add the content to the right places! Try to avoid significant deviations from the provided templates unless you find it necessary for your guide.

Feel free to contribute as much or as little content as you'd like, without any stress. When creating a new repair guide page, it will automatically be categorized as a stub. After filling it up, If you believe the page is complete and unlikely to require further additions, remove the stub tag!

On the contrary, other page types are not categorized as stubs automatically, if you don't finish those pages insert {{stub}} at the top of the code editor to make mark them as a stub.

Filling Up Stub Pages

A stub is a page that is incomplete, lacking essential details, or missing images. These pages provide a foundation for contributors to build upon.

Adding Details

Start by adding relevant details to the stub page. Research and provide accurate information about the repair process, including necessary tools, steps, and precautions.

Include Images

If the stub page lacks images, consider adding visual aids to enhance the understanding of the repair process. Include clear and high-quality images that shows the referenced components and or circuits. If you have schematics you could also include the relevant page.

Image Guidelines

Ensure that the images you upload are clear, relevant, and properly formatted. Images should aid in understanding the repair process and not be redundant.

File Naming

Use descriptive and concise file names for your images. This helps in easy identification and organization. Avoid generic names and include keywords related to the repair.

Image Placement

Integrate images seamlessly into the content. Place images close to relevant text to provide context and aid in comprehension.

Communicating with the Community

Join our Discord to discuss, suggest, or ask about what to help.

Alternatively, you can use the Talk Pages. Every page has a Talk Page associated with it. Click on Discussion in the top left to leave a comment on it, then add ~~~~ to insert a user signature, like so: Patrolin (talk) 15:21, 24 April 2021 (PDT). It is probably easier to just use the Discord, but it's a good use for leaving notice board-like notes.

When responding to someone in the talk pages, do it on a new line and prefix your message with : to give it indentation.

This is the OP speaking. Patrolin (talk) 02:43, 5 May 2021 (PDT)

This is a response to OP. Karar (talk) 02:57, 5 May 2021 (PDT)
Here I've used double colon punctuation :: to respond to the message above. Patrolin (talk) 03:00, 5 May 2021 (PDT)
Another response to OP. Karar (talk) 02:57, 5 May 2021 (PDT)