Help: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
(Help :) (Imported from MoinMoin))
 
mNo edit summary
 
(17 intermediate revisions by 5 users not shown)
Line 1: Line 1:
==I need help editing MusicBrainz==
{{DocumentationHeader|Communication}}


===I'm a new editor. What do I need to know to get started?===
=Where to ask and discuss what=


You'll probably want to be familiar with MusicBrainz's [[Mission|mission]] and [[Code_Of_Conduct|Code of Conduct]] first. There's a lot of information (some, alas, out of date) in the [[MusicBrainz_Documentation|documentation]]. There's also an [[Editing_FAQ|editing FAQ]]. If in doubt, ask. There are lots of editors willing to help.
[[MusicBrainz]] has a big and busy community, with a somewhat wide range of tools to communicate.


===English is not my native language. Can I get help in another language?===
Finding out the appropriate channel depends mainly on what you want.


Currently, it is not possible to [[jira:MBS-4823|search for editors by language]].
==I'm not too sure about that edit I made...==


Until that feature is implemented, you can ask in [[IRC]] or the [[discourse:|forums]]. Some editors also list their [[User_Language|language(s) in the wiki]].
Write [[Edit Note|EditNote]]<code><nowiki></nowiki></code>s! And obviously, answer questions addressed to you from voters on your edits.


===I'm looking for a relevant Style Guideline===
[[Edit Note|EditNote]]<code><nowiki></nowiki></code>s are one of the best place to learn and get answers, as most voters will usually provide opinions and links to the relevant parts of the documentation, or even help you in sorting out edits.


The first thing to try is searching the [[Style_Guidelines|style guidelines]].
Usually, you will get an answer on an [[Edit Note|EditNote]] in a matter of days (that still heavily depends on how popular the artist you're editing is, and if there are voters who regularly provide input on your edits).


You can also find proposed guidelines (and related discussions) in the [[jira:STYLE|bug tracker]].
==I just need an answer, NOW!==


⚫
===I have a question about a specific edit===
Well, can you spare five minutes and search [[Documentation Index|the documentation]] ? Especially the?


If you have a question about somebody else's edit, the best place to ask is in an [[Edit_Note|edit note]].
==It didn't help! And I still need help NOW!==


===I have a specific editing question or need a second opinion===
Then your best shot is the [[IRC|IRC channel]].


If the docs don't answer your question, maybe a real person can. The best options for [[Contact_Us|contacting]] a real person are [[IRC]] or the [[discourse:|forums]].
Be aware, though, that like all IRC channels, you'll obviously get an answer from the people who are ''hanging there at the moment you drop in''. Some of them really are experts (including the project lead and main developers), others are just experts in telling ''jokes about mooses and choco'' (which sure is fine also :-) )


==What do I do if...==
==I have a somewhat generic question, and on IRC, you know, they just tell funny jokes about Mooses and Choco...==


⚫
===I think I found a bug===
Assuming you went through the [[Documentation Index|documentation]] already without finding your answer, you may certainly try either the [[MusicBrainz Forum|MusicBrainzForum]] or the [[Users Mailing List|UsersMailingList]], depending on your preference.


You can report bugs using the [[Bug_Tracker|bug tracker]].
Usually, you'll get an answer in less than a day (and possibly a bit less jokes).


⚫
===I think I found a problem in the documentation===
⚫
==My question is pretty specific, actually==


You can report problems with the documentation using the [[Bug_Tracker|bug tracker]]. There are specific sections for style guidelines and documentation.
Our [[Mailing List|MailingList]]<code><nowiki></nowiki></code>s (and so the [[MusicBrainz Forum|MusicBrainzForum]]) are split into different topics (developers, style, etc), and you will probably find the appropriate one for your question.


If it's a minor problem (e.g. a typo), you can [[Special:UserLogin/signup|edit the wiki]] directly.
Also, if your question pertain to something that is not really clear in the documentation, you are strongly encouraged to just edit the relevant wiki page and ask it there. That way is certainly a better choice for the long term, as your question not only will be answered but the documentation will benefit from it by being updated to clarify what was not in the first place.


===I'm having a problem with a specific editor===
⚫
==I found a bug!==


As it says in [[MusicBrainz_Principles|MusicBrainz Principles]], "seek mediators".
Then you may report it! Check our [[Bug Tracker|BugTracker]] (be sure to verify your bug is not already reported).


You can find people willing to help in [[IRC]] or the [[discourse:|forums]].
⚫
==I found a problem in the documentation, and I think I can fix it==


If you want to report a [[Code_Of_Conduct|Code of Conduct]] violation, you can contact [mailto:support%40musicbrainz.org support@musicbrainz.org].
Just go ahead and edit the page on the [[MusicBrainz Wiki|MusicBrainzWiki]]. A few recommendations , though:
* please create a [[Wiki Account|WikiAccount]] so your edits are signed (this is not the same as your editor [[Musicbrainz Account|MusicbrainzAccount]])
* if the page you wanna edit is part of the official editor documentation, you definitely should not randomly change the meaning of it (especially the [[Style Guideline|StyleGuideline]]<code><nowiki></nowiki></code>s). Such a change should be discussed first (see below)
* just as with any Wiki, we have some code of conduct rules - obviously you shouldn't just remove content because it doesn't please you, or alter other people questions, etc...


If you'd like to discuss your problem as discreetly as possible (e.g. your problem is with a core MusicBrainz team member), you can contact our Community Manager directly at [mailto:community-manager@metabrainz.org community-manager@metabrainz.org].
==I have this idea to propose about a style improvement==


===I have a question about Picard===
Our favorite process to do so works roughly as follow:
* taste the waters, especially if you're new: try to see what other people think about "the question" you are trying to solve, and dig a bit on the wiki (or the [[Mailing List|MailingList]]<code><nowiki></nowiki></code>s archives) to check if a similar proposal was not suggested earlier
* when done, create a new wiki page that describes your style proposal (you may ask for help from a more experienced [[WikiZen]] if you need)
* post a [[RFC|request for comments]] to the [[Style Mailing List|StyleMailingList]], and see what's the reaction
* you may also open-up a ticket in the [[Bug Tracker|BugTracker]] (that helps us in keeping a vision of our history)
* your [[RFC|request for comments]] will eventually become a [[RFV|request for veto]] and will eventually become reality!


Official Picard documentation is at [https://picard.musicbrainz.org/ picard.musicbrainz.org].
More details about all that in the [[Style Council|StyleCouncil]] page.


As with other topics, you can usually find help in [[IRC]] or the [[discourse:|forums]].
==I have this new idea for a super-new-feature...==

... but that involves additional code development, right? :-)

Whether your idea will be implemented or not pretty much sums-up to the question: "is one of the developers interested in implementing it?".

While obviously the easiest way to have it actually implemented is to [[How To Contribute|contribute the code]] for it yourself (if you have such skills), even non-developers are encouraged in providing feedback and new ideas on future developments.

To do so, usually:
* get yourself familiar with the way the project will evolve (check the)
* create a wiki page describing your proposal
* possibly look for feedback from other users on the [[Mailing List|MailingList]]<code><nowiki></nowiki></code>s
* hook-up with a developer!

[[Category:To Be Reviewed]] [[Category:FAQ]] [[Category:Proposal]] [[Category:Communication Forum]]

Latest revision as of 13:59, 24 May 2020

I need help editing MusicBrainz

I'm a new editor. What do I need to know to get started?

You'll probably want to be familiar with MusicBrainz's mission and Code of Conduct first. There's a lot of information (some, alas, out of date) in the documentation. There's also an editing FAQ. If in doubt, ask. There are lots of editors willing to help.

English is not my native language. Can I get help in another language?

Currently, it is not possible to search for editors by language.

Until that feature is implemented, you can ask in IRC or the forums. Some editors also list their language(s) in the wiki.

I'm looking for a relevant Style Guideline

The first thing to try is searching the style guidelines.

You can also find proposed guidelines (and related discussions) in the bug tracker.

I have a question about a specific edit

If you have a question about somebody else's edit, the best place to ask is in an edit note.

I have a specific editing question or need a second opinion

If the docs don't answer your question, maybe a real person can. The best options for contacting a real person are IRC or the forums.

What do I do if...

I think I found a bug

You can report bugs using the bug tracker.

I think I found a problem in the documentation

You can report problems with the documentation using the bug tracker. There are specific sections for style guidelines and documentation.

If it's a minor problem (e.g. a typo), you can edit the wiki directly.

I'm having a problem with a specific editor

As it says in MusicBrainz Principles, "seek mediators".

You can find people willing to help in IRC or the forums.

If you want to report a Code of Conduct violation, you can contact support@musicbrainz.org.

If you'd like to discuss your problem as discreetly as possible (e.g. your problem is with a core MusicBrainz team member), you can contact our Community Manager directly at community-manager@metabrainz.org.

I have a question about Picard

Official Picard documentation is at picard.musicbrainz.org.

As with other topics, you can usually find help in IRC or the forums.

Retrieved from "https://wiki.musicbrainz.org/index.php?title=Help&oldid=74287"