Contribution Guide: Difference between revisions

From The Brainfog Wiki
(→‎Creating and editing: Reduced text size, renamed sect and added updated instructions reflective of UI changes.)
(Added new sect regarding inactivity policy.)
 
(3 intermediate revisions by the same user not shown)
Line 10: Line 10:


To make changes to this wiki, you will need an account. This is something we require and it is to help protect the wiki. You can request an account by reaching out to the site administrators in [[Contact Us]].
To make changes to this wiki, you will need an account. This is something we require and it is to help protect the wiki. You can request an account by reaching out to the site administrators in [[Contact Us]].
Once you meet our requirements, take a look below to learn how to fit right in with our existing content which is specially crafted to be easy to read and reference!


== Contribution Philosophy ==  
== Contribution Philosophy ==  
Line 37: Line 35:
=== Talk Pages ===
=== Talk Pages ===


If you are contributing to a new page that you have never contributed to before, be sure to check the talk page for that specific wiki page, as it may contain information you should bare in mind before taking the action you intended to take.
If you are contributing to a new page that you have never contributed to before, be sure to check the talk page (if it exists) for that specific wiki page, as it may contain information you should bare in mind before taking the action you intended to take.


=== Edit Auditing ===
=== Edit Auditing ===
Line 43: Line 41:
You should always aim to give a brief summary of the changes you make in each edit you make, so that other contributors and administrators can understand what action you have taken at a glance. You can be mistaken for a malicious actor if you have removed or added a lot of text and provided no context behind the editing of that page, even if your action is perfectly legitimate.
You should always aim to give a brief summary of the changes you make in each edit you make, so that other contributors and administrators can understand what action you have taken at a glance. You can be mistaken for a malicious actor if you have removed or added a lot of text and provided no context behind the editing of that page, even if your action is perfectly legitimate.


=== Minor / Normal Edit ===
=== Minor vs Normal Edit ===
Please denote your edits as minor if they change things such as formatting, capitalisation, etc. But do not add or remove content. This helps our [[patrollers]] as normal edits are automatically marked for review, which would be a waste of time for a patroller if it did not actually add anything worth checking, versus the previous edit.
Please denote your edits as minor if they change things such as formatting, capitalisation, etc. But do not add or remove content. This helps our [[patrollers]] as normal edits are automatically marked for review, which would be a waste of time for a patroller if it did not actually add anything worth checking, versus the previous edit.
== Additional Contributor Considerations ==
=== Inactivity ===
If you have not logged in to the wiki in 90 days, your account will automatically be blocked (you will be able to login, but not make any edits, etc.) This procedure has been put in place to protect the wiki. In order to have your account unblocked, you will need to reach out to a [[Contact Us | administrator.]]

Latest revision as of 04:36, 8 April 2024

Getting Started

So, you want to contribute? This is excellent news!

It might seem a bit intimidating at first but this wiki system will quickly become your bestfriend.

Creating & Editing

The way to make edits and create pages is to simply search them in the search bar! For example, if you want to make a page on Depression, type 'Depression' in the searchbar. If you get no results, you will get the opportunity to create the page, and when someone else searches 'Depression' that page will come up! If the page already exists, there will be a edit button on the page for you to click to make your own edits! With our current UI, the edit button looks like a square with a pencil in it.

Requirements

To make changes to this wiki, you will need an account. This is something we require and it is to help protect the wiki. You can request an account by reaching out to the site administrators in Contact Us.

Contribution Philosophy

This section is designed to help you understand how to best serve the users of this information database by understanding and implementing the philosophy this wiki functions best by. These aren't specifically rules, but following them helps to create a consistent and easy viewing experience and reduces the amount of edits that need to be made to polish contributions. It is important to note however that a consistently poor following of this philosophy may cause your account to be suspended.

Clean and concise

As much information should be provided as possible, in as little as possible. The target audience for this wiki is brainfogged individuals and it will be discouraging to read walls of text, even if it is helpful. Writing as much as possible in as little as possible without unreasonably compromising on information regarding the subject should be the goal.

As it relates to brainfog

Many of the pages here can be steered off topic if the focus of this wiki is not kept in mind. Whilst you might be able to include additional facts compared to what is already avaliable, it could be that it was never included because the facts were not useful knowledge when in light of the reason it is mentioned at all on a brainfog wiki.

Formatting

It stands to reason that it would be a good idea to make your contribution human readable given the target audience, and although it sounds like it could be complicated and daunting, it is rather simple! Take a look here at our personal favourite cheatsheet.

Ontop of using markup, giving appropriate pacing to sections is also important. Text is much easier to read and reference when it is broken up into headings.

Complex Grammar

Avoiding the use of language that requires a high understanding of the language it is written in is helpful both to translation and comprehension of what has been wrote, especially for brainfogged individuals. Without compromising on the message, you should aim to use lower level language (not slang) to aid in peoples understanding.

Talk Pages

If you are contributing to a new page that you have never contributed to before, be sure to check the talk page (if it exists) for that specific wiki page, as it may contain information you should bare in mind before taking the action you intended to take.

Edit Auditing

You should always aim to give a brief summary of the changes you make in each edit you make, so that other contributors and administrators can understand what action you have taken at a glance. You can be mistaken for a malicious actor if you have removed or added a lot of text and provided no context behind the editing of that page, even if your action is perfectly legitimate.

Minor vs Normal Edit

Please denote your edits as minor if they change things such as formatting, capitalisation, etc. But do not add or remove content. This helps our patrollers as normal edits are automatically marked for review, which would be a waste of time for a patroller if it did not actually add anything worth checking, versus the previous edit.

Additional Contributor Considerations

Inactivity

If you have not logged in to the wiki in 90 days, your account will automatically be blocked (you will be able to login, but not make any edits, etc.) This procedure has been put in place to protect the wiki. In order to have your account unblocked, you will need to reach out to a administrator.