Guidance for Comrades

Comrades are Habiticans who create third-party tools. This includes but is not limited to: web-based tools, apps, browser extensions, any code that uses Habitica's API, and CSS templates. If you would like to create such tools, it is important to read all of this page. The other resources that it links to will also be of use to you. Being a Comrade is one way of Contributing to Habitica.
==Becoming a Comrade==
First of all, welcome to the Habitica family! As an open source project, Habitica fully welcomes anyone in our community who wants to offer their skills to build upon the Habitica experience. To help your creation roll out smoothly and to keep the divide between official and unofficial apps clear to our players, we've put together these guidelines.
Please read this whole page before starting work on your tool to ensure that you don't need to change it later. You may also want to check that a similar tool has not already been created at the Extensions, Add-Ons, and Customizations page. The Application Programming Interface page will teach you how to use the API.
You can join the Aspiring Comrades guild to share your work, get feedback, discuss ideas with fellow contributors, and get your tool tested by other players.
Our GitHub repositories for each platform can be used to check out our code and pull any assets you may need from them:
* Habitica GitHub
* Habitica Android GitHub
* Habitica iOS GitHub
===Seeking Assistance===
For questions about using Habitica's API that are not answered in Application Programming Interface, feel free to ask in the Aspiring Comrades guild. To ensure easy assistance, post a link to your raw code from your preferred repository (e.g., GitHub).
For questions regarding the Habitica website's CSS and modifying it with user styles using browser extensions like Stylus, ask in the Aspiring Tailors guild.
For general programming questions, there are many guilds in Habitica about Programming and Programming Languages.
==Creating a Wiki Page==
Once your tool is running well, a wiki page can be created for it and linked to from Extensions, Add-Ons, and Customizations. This lets Habiticans find your tool easily. If you feel uncomfortable creating your own wiki page, then you can link your creation in the Wizards of the Wiki guild. There, the scribes will be able to create a page for you.
When creating the wiki page, please use the :Template:Infobox software template to ensure information is formatted and specified correctly.
Please note that your tool should follow all relevant advice in the "Rules for Third-Party Tools" section above before the wiki page is created. Habitica's staff might temporarily remove the wiki page for any tool that needs adjustments to comply with that advice. Ask in the Aspiring Comrades guild if you need help implementing the rules!
==Contributor Tier Process==
To request a Comrade contributor tier:
* Check that your tool follows all relevant guidance in the "Rules for Third-Party Tools" section above, including the "Notifying Staff about your Tool" subsection.
* If your tool is for public use, post to the Aspiring Comrades guild with links to:
** the tool
** the tool's full source code if it uses Habitica's API
** documentation for the tool, if any
** the tool's wiki page if one has already been created
Other Comrades might give feedback and help you tweak your tool. It's not essential for you to follow their advice but you might like to consider it. 
At this point, you should send an email to admin@habitica.com with the subject line "Comrade Tier Requested". This is to ensure that it is flagged for the correct person for evaluation. You must include the following:
* An affirmation that you notified the staff about your tool when you began development
* Your UUID and username
* The name of your tool
* A link to the source code
* A link to any documentation that exists 
* A link to the wiki page, if one has already been created
If a staff member asks you to make changes to the tool's code or appearance, it will likely be necessary for those changes to be made before a tier will be considered, although discussion and clarification via email is always welcome. 
Tiers are awarded at the discretion of the staff and take into consideration the applicability of the tool to Habitica's wider userbase and whether the tool improves the Habitica experience in a spirit consistent with the values of the community.
Once approved by staff, you will be given a tier or credit towards a tier. Keep in mind that higher tiers require more work, so partial credit is more likely to be given if you have more than one tier already.
==See Also==
* Application Programming Interface
* Extensions, Add-Ons, and Customizations
* Pro Git Book - A great guide to learning how to use Git and GitHub repositories.
* Hello World Tutorial - A quick guide to using GitHub.
zh:同志
Category:Contributing
Category:Pages with files missing alt tags