SmashWiki:Edit summaries: Difference between revisions

From SmashWiki, the Super Smash Bros. wiki
Jump to navigationJump to search
(Here goes nothing.)
 
No edit summary
Line 3: Line 3:


Edit summaries can be entered in the white text box just below the text box where the main edits are made, under the word "Summary:" and above the checkbox with "Watch this page". The summary box does, however, have a text limit, and it is suggested that if you are unable to enter the entire summary into the box that you post on the talk page immediately following the edit, with a note in the summary stating that you plan on doing so.
Edit summaries can be entered in the white text box just below the text box where the main edits are made, under the word "Summary:" and above the checkbox with "Watch this page". The summary box does, however, have a text limit, and it is suggested that if you are unable to enter the entire summary into the box that you post on the talk page immediately following the edit, with a note in the summary stating that you plan on doing so.
''Always be sure to read an edit summary'' before acting on someone's edit. Edit summaries can be seen in [[Special:RecentChanges]] or the history of the page. This way, the full information of the edit is understood by all parties.


==Occasions when an edit summary should always be used==
==Occasions when an edit summary should always be used==
Line 12: Line 14:
*'''When changing [[Template:WikiStatusValue]].'''
*'''When changing [[Template:WikiStatusValue]].'''
**This template is intended to show users what state the wiki is in, and should only be changed when there is a good reason for it to be lower or higher (as the case may be). If there is no proper reason provided as to why the change was made, it will likely be undone. Once again, a simple reason is not always preferable, and if the only reason that can be provided is one such as "we're busy", the edit may need to be rethought.
**This template is intended to show users what state the wiki is in, and should only be changed when there is a good reason for it to be lower or higher (as the case may be). If there is no proper reason provided as to why the change was made, it will likely be undone. Once again, a simple reason is not always preferable, and if the only reason that can be provided is one such as "we're busy", the edit may need to be rethought.
*'''When removing content from a talk page.'''
**Generally, it is considered unacceptable to remove content from a talk page. However, if content is being removed for a good reason (such as archiving, fixing formatting, removing personal information, etc.), please be sure to explain why it is a good reason. That way, everyone understands that you are not breaking any policies. (See [[SW:TALK]] for more information.)


==Occasions when an edit summary is highly recommended, but not necessary==
==Occasions when an edit summary is highly recommended, but not necessary==
*'''When creating a new page.'''
*'''When creating a new page.'''
**Whenever a new page is created, the reason why the page is necessary should be included. This will provide all users with a reason as to why they should support it, and may help keep unnecessary future discussion.
**Whenever a new page is created, the reason why the page is necessary should be included. This will provide all users with a reason as to why they should support it, and may help keep unnecessary future discussion.
**'''EXCEPTION''': Redirects, for the most part, do not require an edit summary, as the system will add one for you.
*'''When adding a new section to a page.'''
*'''When adding a new section to a page.'''
**This should be on a case-by-case basis. If a section is being added that is on all other pages of that type for consistency, an edit summary is not necessary (however, a short one such as "Adding for consistency" should be considered). However, if this is a large section which has never been added to a page previously, users deserve to know why it is thought to be necessary, and it limits the chances of the user in question having to defend themselves if such a discussion were to come up.
**This should be on a case-by-case basis. If a section is being added that is on all other pages of that type for consistency, an edit summary is not necessary (however, a short one such as "Adding for consistency" should be considered). However, if this is a large section which has never been added to a page previously, users deserve to know why it is thought to be necessary, and it limits the chances of the user in question having to defend themselves if such a discussion were to come up.

Revision as of 14:03, August 27, 2015

Template:Proposed policy Edit summaries are an important part of the Wiki, as they are useful to explain an edit that may be controversial or otherwise needs an extra notes. There are some occasions when making an edit summary is not important- however, other situations require a more detailed edit summary in order to avoid future conflict.

Edit summaries can be entered in the white text box just below the text box where the main edits are made, under the word "Summary:" and above the checkbox with "Watch this page". The summary box does, however, have a text limit, and it is suggested that if you are unable to enter the entire summary into the box that you post on the talk page immediately following the edit, with a note in the summary stating that you plan on doing so.

Always be sure to read an edit summary before acting on someone's edit. Edit summaries can be seen in Special:RecentChanges or the history of the page. This way, the full information of the edit is understood by all parties.

Occasions when an edit summary should always be used

  • When reverting someone's edit.
    • Sometimes, a misinformed but well-intending user may add something that is false, unnecessary, or otherwise something that needs to be removed. However, having your edit reverted can sometimes feel insulting. This can be alleviated with the addition of a simple edit summary explaining why the edit is unnecessary. This does not, however, include summaries with simple phrasing such as "bad edit". This is often more insulting than the revert itself, and will nearly always lead to an edit war or unnecessary discussion/arguing on the talk page.
    • EXCEPTION: In the case of a vandal, edit summaries are not necessary, but still recommended.
  • When removing a large part of a page.
    • Everyone works together on a page, and when someone sees that a piece of the page they may have worked hard on is removed, they deserve an explanation as to why. As before, simple phrasing such as "unnecessary" does not help. Say why it's unnecessary. Is it covered on another page? Is it irrelevant to the Super Smash Bros. series? These are things that users deserve to know, and it can also prevent them from making the same mistake in the future.
  • When changing Template:WikiStatusValue.
    • This template is intended to show users what state the wiki is in, and should only be changed when there is a good reason for it to be lower or higher (as the case may be). If there is no proper reason provided as to why the change was made, it will likely be undone. Once again, a simple reason is not always preferable, and if the only reason that can be provided is one such as "we're busy", the edit may need to be rethought.
  • When removing content from a talk page.
    • Generally, it is considered unacceptable to remove content from a talk page. However, if content is being removed for a good reason (such as archiving, fixing formatting, removing personal information, etc.), please be sure to explain why it is a good reason. That way, everyone understands that you are not breaking any policies. (See SW:TALK for more information.)

Occasions when an edit summary is highly recommended, but not necessary

  • When creating a new page.
    • Whenever a new page is created, the reason why the page is necessary should be included. This will provide all users with a reason as to why they should support it, and may help keep unnecessary future discussion.
    • EXCEPTION: Redirects, for the most part, do not require an edit summary, as the system will add one for you.
  • When adding a new section to a page.
    • This should be on a case-by-case basis. If a section is being added that is on all other pages of that type for consistency, an edit summary is not necessary (however, a short one such as "Adding for consistency" should be considered). However, if this is a large section which has never been added to a page previously, users deserve to know why it is thought to be necessary, and it limits the chances of the user in question having to defend themselves if such a discussion were to come up.
  • When adding a template such as Template:Image or Template:D.
    • Unless it's obvious why you're adding such a template (like if the page has no images whatsoever, or is a spam page), you should always consider explaining why you are adding one of these templates.
    • NOTE: If you can easily sum up the reason, you may also want to consider just adding it to the template itself, by writing {{d|(insert reason here)}}.
  • When making a page for a Smasher or a tournament.
    • Whenever a page is made for a Smasher or a tournament, particularly if the user who creates the page is directly related to said Smasher or tournament, a reason should be provided as to why it is notable enough to be included on the wiki. Otherwise, its notability may be put into question.
  • When removing a piece of trivia.
    • As trivia sections are intended for otherwise pointless information that would not be mentioned anywhere else in the mainspace, removing a piece of trivia may cause arguments, as there is a very thin line between notable and not notable. Therefore, always be sure to state why you believe it's unnecessary. See SW:TRIVIA for more information.

Occasions when an edit summary is unnecessary

  • When fixing grammar.
    • Grammar fixes are simple edits and do not need an explanation. They help keep the wiki looking professional, and you will rarely be questioned for making such an edit.
  • When making a forum post.
    • The forums are intended for discussion, and therefore you should not need to provide a reason as to why you are making such a post. If you do feel the need to specify, you can include it in the forum post itself.
  • When editing a talk page.
    • Similar to the forum posts, adding something to a talk page should not require an explanation. The reason why should be covered in the post itself.