Thank you for your interest!
The following is a set of guidelines for contributing to COMP/CON, the LANCER TTRPG digital toolkit. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to compcon@massifpress.com.
First, dev discussion is mostly handled in the #comp-con channel of the Official LANCER Discord, and participation in that channel is a requirement for pull request acceptance. After your first accepted pull request, you'll get the Comp-Con Dev role.
To pull and build COMP/CON locally:
git clone git@github.com:massif-press/compcon.git
yarn
yarn devWhich will open a browser window pointed to localhost:8080. Hot Module Reload is enabled, which means that the app should refresh as you save code. Occasionally (especially after certain syntax errors) this can start to fall off, in part or completely. If this is the case, a refresh will either get HMR working again or find your error.
Unless you're working on something specifically for an Electron build, prefer developing to browser.
WIP
WIP
Unsure where to begin contributing? You can start by looking through these beginner and help-wanted issues:
- Beginner issues - issues which should only require a few lines of code.
- Help wanted issues - issues which should be a bit more involved than
beginnerissues.
COMP/CON uses commitizen to produce a standard-version changelog. Pull requests that include commits that are not conventional commit formatted will not be accepted.
COMP/CON comes with a commitizen dev dependency, so when making commits use yarn commit instead of git commit, or use the VSCode Commitizen Support package.
WIP
WIP
WIP
WIP
WIP