Difference between revisions of "ArchWiki:Contributing"

From ArchWiki
Jump to: navigation, search
m (Maintenance: all the other headings are "*ing")
m (Prerequisites: let's not discourage new editors by saying that knowledge of these articles is required; change heading to "Resources")
Line 37: Line 37:
 
If you want to radically restructure or rewrite an article or a group of articles, announce and explain your intention in an appropriate talk page first, giving any other interested users some reasonable time to reply and share their view.
 
If you want to radically restructure or rewrite an article or a group of articles, announce and explain your intention in an appropriate talk page first, giving any other interested users some reasonable time to reply and share their view.
  
== Prerequisites ==
+
== Resources ==
  
 
Here is a list of pages contain information needed for contributing.  
 
Here is a list of pages contain information needed for contributing.  

Revision as of 02:00, 20 December 2014

zh-CN:ArchWiki:Contributing ArchWiki strives to be a clear, comprehensive and professional model of documentation. In order to reach that goal we have to organize the job in a rational and functional way: this article tries to explain schematically what are the most important tasks you can give your help to accomplish.

This is a community effort, but if you take on the task seriously, a formal position as a wiki maintainer may be in order.

The 3 fundamental rules

There are 3 simple rules that all contributors, including novices, should try their best to follow as a sign of respect to the other users of the wiki: #Always properly use the edit summary, #Do not make complex edits at once and #Announce massive edits in a talk page.

All wiki contributors must assume and expect that other users will check their edits sooner or later, and respect their right to do so by making it as quick and easy as possible by following these recommendations. Those familiar with collaborative software projects will easily understand the analogy between wiki edit summaries and git commit messages, and between wiki edit diffs and git diffs.

Warning: Any edits to articles that do not respect these fundamental rules, and as such cannot be comprehended with reasonable effort, may be completely reverted without any other warnings, especially when affecting popular articles.

Always properly use the edit summary

The edit summary is the little text box that is found below the main editing area and just above the "Save page" button. It is very important to always write, in a succinct way, what has been done and why. Note that internal wiki links do work in edit summaries, so use them to link to any related discussions or articles; similarly, paste any urls to relevant edit diffs or external resources, such as forum threads or mailing lists.

Only in case of minor edits, e.g. grammar or orthography corrections or the simple rewording of a sentence, the "why" part can be omitted; analogously, starting a new discussion or replying to an existing one does not require to restate the message in the edit summary.

Tip:
  • Take a look at the edit summaries in the Recent Changes to get an idea of what you should write in your summary, but be warned that, unfortunately, not all users respect these guidelines.
  • To receive a warning when leaving a blank edit summary, check "Prompt me when entering a blank edit summary" in Special:Preferences.

Do not make complex edits at once

If you want to make an extensive change to a page, be it a normal article or a discussion page, always split your work in several simple edits, for example according to the various logical steps needed to complete it. If in doubt, preview the resulting diff with the "Show changes" button and wonder if another user would be able to understand it, also considering the edit summary as explained above. Some common operations that generate confusing diffs are:

  • Moving a section in an article and at the same time editing its content. Solution: move the section unchanged, save, and change its content in a following edit.
  • Reordering several sections of an article at the same time. Solution: move only one section per edit.

Announce massive edits in a talk page

If you want to radically restructure or rewrite an article or a group of articles, announce and explain your intention in an appropriate talk page first, giving any other interested users some reasonable time to reply and share their view.

Resources

Here is a list of pages contain information needed for contributing.

  • Help:Article naming guidelines discusses effective article naming strategies and considerations to ensure readability and improve navigation of the wiki. Read it before creating any new page.
  • Help:Editing outlines both widely-known MediaWiki markup and ArchWiki-specific guidelines. A must-read for any would-be contributors.
  • Help:Discussion guide you how to discuss with people in the talk page.
  • Help:Style gives guidelines for the standardization of style in ArchWiki articles.
  • Help:Category explain how to set page category, how to create missing categories pages and how to move a page to a different category.
  • ArchWiki Translation Team has a step by step introduction for creating a new translation page. Follow it to translate pages to your own language.
  • Help:i18n serves as a comprehensive guideline for ArchWiki internationalization and localization.
  • Help:Procedures is a collection of useful check lists for complex operations.

See the help category for all help articles.

Creating

Ensure you understand the philosophy of ArchWiki and think about what others may want to read (see ArchWiki:Requests for ideas). As mentioned, the wiki's scope is quite wide.

Talk to the admins for help coordinating major projects.

Improving

Content editing, proofreading, and updating are never-ending tasks on any wiki. If you want to help, just register an account and start performing your magic.

Non-Arch users

Non-Arch users are welcome to contribute; in fact anyone can register an account. They should, however, be confident that any edits also apply to Arch, avoiding comments specific to other distributions. For example, a Fedora user contributing to the systemd page would be fine, but mentioning that the newly added content works on Fedora would be edited out as irrelevant.

Maintaining

  • Help patrolling the Recent Changes, reporting and fixing questionable edits.
  • Flag articles with appropriate article status templates, like {{Deletion}}, {{Out of date}}, {{Accuracy}}, etc.
  • Add some articles to your watchlist and protect them against counter-productive edits.
  • Participate in discussions in the various talk pages: most users will be interested in following the most recent posts to generic discussions at this link. Maintenance-specific posts are instead listed in [1], [2], [3] and [4]; furthermore, ArchWiki:Requests is used as a talk page despite its namespace.

Organizing

Sorting, categorizing, and moving articles around has become a major task for all wiki maintainers implementing and improving the category tree.

Translating

Add or improve translations; ensure that translations are in sync with each other. Some languages have started collaboration projects (see list below) to efficiently organize the translation of the articles. Please consider joining your language's Translation Team or at least informing it when you are starting translating an article.

Some languages use external wiki, they may require different steps for translation. Help:i18n has a list of external wikis.

Special messages translation

There are some special messages used in Arch Wiki, please provide their translation for your language in the following link:

  • Also in (Message in Categories tree): Add translation here
  • Talkpagetext : Add translation here

Brainstorming

If unsure where to begin, or you feel awkward about editing other people's work, you may also contribute by posting ideas and suggestions at Forum & Wiki discussion section of the Arch Linux Forums.

Back-end maintenance

Use the Arch Linux Bugtracker to report bugs and contribute fixes and improvements to the MediaWiki codebase. See the list of reported bugs for the ArchWiki back-end.

Complaining

If you have any generic negative remarks or complaints about how the wiki is moderated or administered, please leave a message in ArchWiki talk:Administrators. Of course it should not be necessary to state that it is indeed possible to complain about something using a civil and respectful tone :) For complaints regarding specific edits or articles, please use a more appropriate talk page.