Contribution

header

Contributing Guidelines

Hello and thanks for considering contributing to this project. Your contribution(s), if significant, may be rewarded with a special contributor status and a special color; more info here. If you're new to programming in general and want to get started, I would recommend the visual studio code editor (not visual studio) and I like my setup which you can find here: https://github.com/cozuya/visual-studio-code-settings-and-snippets

I only have the following guidelines:

Before working on a feature, a) make sure it's an open, not "suggested" issue on the github issue page and b) it is unassigned. If you start working on something non-trivial, ask in discord dev channel to have it assigned to you.
Your code should pass lint.
Your editor should use prettierjs.
Functions that either a) return a value or b) have arguments (non-anonymous/lambda) that aren't obvious i.e. not i/index/event should use JSDoc comments to explain the types and return types of that function.
If you make a feature, please commit to supporting it. If there's problems on an issue you've completed, please make sure you can take care of it.

Contributing to the Site

Initial Code Installation/Development Steps:

Follow the step-by-step instructions more specifically detailed in the Read Me.

Dev Helper Accounts:

In order to make games and test new features faster in them, we provide default Dev Helper accounts across the top of the /game page easily ready for use.
Uther, Jaina, Rexxar, Malfurian, Thrall, Valeera, Anduin, aaa, bbb, ccc, ddd, eee, fff, ggg, hhh
There is a yarn script you may run once server or dev yarn scripts are already running called create-accounts which will populate all of the helper accounts into the database.

yarn create-accounts

This allows you to log in to an account in one click.
To better use the Dev Helpers, you'll most likely need a browser extension such as Chrome's SessionBox to have multiple sessions on the same browser.
No, incognito will not work.

Assigning a Local Mod Account:

In order to better test all functions of the site in a local development environment it is useful to assign an admin account. This is done for you through the secret-hitler/scripts/assignLocalMod.js file courtesy of contributor Hexicube. After running the create-accounts script you will have the helper accounts populated into the database. Running the next line below will then assign Uther to the admin staffRole to better test all site functions in testing.

yarn assign-local-mod

Upon seeing the end result in the terminal of Assigned. you will know it worked. Just refresh your localhost:8080 page at this point and then you will have a local mod to test additional functions of the site with in a development mode environment.

Contributing to the Wiki

To clone this wiki locally, run the following command line in your terminal:

git clone https://github.com/cozuya/secret-hitler.wiki.git

We appreciate any helpful contributions to help improve this wiki to be most useful to the Secret Hitler.io Community.

Discord Development Channel and GitHub Issues Pages

As a contributor it is also recommended and encouraged to help participate in discussion of bugs, enhancements, and new community policies on the discord development channel as well as on the GitHub issues page.

Contributor Role Recognition

Contributors are recognized for their significant contributions to either the site's code, discord, or wiki, and are rewarded with special roles on the game site, discord, and github.

On site, Contributor's usernames will be rewarded with a special color.
On GitHub, you will notice a new tag next to your name anytime you post here on GitHub with the text: "Contributor".
On Discord, Contributors have their own private channel and are also provided 5 different color roles in addition to the default contributor color role. Just speak to Moira or Vig when you decide what color is right for you. There is no limit to how many times you may have your color changed.

Discord Contributor roles are as follows:

@💙Contributor - Default Contributor
@💜Contributor - Purple
@💗Contributor - Pink
@💛Contributor - Yellow
@💚Contributor - Green
@🖤Contributor - Black

Developers

The Developer role is given to the trusted Contributors who actively work to improve the project. Unlike Contributor, the Developer title may be removed if a Contributor is not present to help out, or is deemed untrustworthy.
On Discord, Developers have a separate role given to them. This role can be pinged to inform developers of urgent bugs or crashes. Developers also have access to a channel where they can privately discuss the future features, or any confidential problems that may arise.

Collaborators

Collaborators are given special increased access to GitHub functions such as merging Pull Requests into the master branch as well as editing the wiki directly within the application using the Editing mode.
Collaborators are trusted by the Owner to remain above reproach in their presence on the game site, discord, and on GitHub.
Collaborator is a role similar to 📛Administrator in that it will not be normally assigned to just any helpful player. 🌀Moderators and 💙Contributors are very respected for the work they do, however, I hold my Administrators and Collaborators to much higher standards and the level of depth of trust and relationship between us must be great, as these roles have much more power than their alternatives.
Very Actively Dependable Contributors are the most likely to be asked to help collaborate on this Project on GitHub.