mirror of
https://github.com/bra1n/townsquare.git
synced 2025-03-14 22:04:36 +00:00
300395de08
* add support for custom fabled (closes #110) * 2.13.0 * show custom fabled first * add recordVoteHistory & clearVoteHistory to session menu * Update CHANGELOG.md * socket part of toggle recordVoteHistory analogous to isNight * remove accidental * Add files via upload * add custom fabled * Add option to reduce night animations to save power. * add fallback icon for fabled * changelog * disable all animations now * linter * add 'on the block' indicator - after vote, ST chooses to put onto block / empty block / no change to block - player menu has add / remove from block - players are automatically removed from the block when (i) they die (ii) another player is put onto block - fixed crash on add/remove/etc player mid vote * hide rounded corners on maximized modals (barely visible anyway) * ST always sees vote history i.e. toggle affects only players * empty block at night * avoid clashing with seat icon * nlc: toggle within session.js * lint * minor * Use proper "Exile" terminology for exile * Add info about "Banishment"->"Exile" to CHANGELOG * requested changes * remove direct ST control of block * player menu order * move block/night logic from socket to menu * minor fix to previous * on block -> marked * requested changes * requested change Co-authored-by: Steffen <steffen@baumgart.biz> * fix players being moved or removed during a nomination (closes #164) add vue linter * let's try adding a lint error * linter adjusted * it's working! * requested change record marked player id in session * feedback implemented npm audit * prepare develop branch * adjust linter config * revert version bump * fixes & visuals * Update CHANGELOG.md * restore old lint command (fixes #170) * minor fix default * show jinxed interactions on character reference modal * 2.13.0 * changelog Co-authored-by: nicfreeman1209 <nicfreeman1209@gmail.com> Co-authored-by: nicfreeman1209 <14160941+nicfreeman1209@users.noreply.github.com> Co-authored-by: Adrian Irving-Beer <wisq@wisq.net> Co-authored-by: Andrew Conant <emptierset@gmail.com>
111 lines
4.1 KiB
Markdown
111 lines
4.1 KiB
Markdown
# Contributing Guide
|
|
|
|
Hi! I'm really excited that you are interested in contributing to this project.
|
|
Before submitting your contribution, please make sure to take a moment and read through the following guidelines:
|
|
|
|
- [Code of Conduct](CODE_OF_CONDUCT.md)
|
|
- [Issue Reporting Guidelines](#issue-reporting-guidelines)
|
|
- [Pull Request Guidelines](#pull-request-guidelines)
|
|
- [Development Setup](#development-setup)
|
|
- [Project Structure](#project-structure)
|
|
|
|
## Issue Reporting Guidelines
|
|
|
|
- Report a new issue either through [GitHub](https://github.com/bra1n/townsquare/issues/new/choose) or [Email](mailto:steffen@baumgart.biz)
|
|
- Please include with your issue the browser and operating system you're using as well as steps necessary to reproduce the bug, if any
|
|
- Be patient, I'm working on this project in my spare time :-)
|
|
|
|
## Pull Request Guidelines
|
|
|
|
- The `main` branch is what is currently deployed to the website. All development should be done in dedicated branches.
|
|
|
|
- The `develop` branch contains the changes that will be deployed to main next. In order to prepare a release, development
|
|
branches should have their Pull Request against `develop` and only releases should be merged from `develop` into `main`.
|
|
|
|
- Work in the `src` folder and **DO NOT** checkin `dist` in the commits.
|
|
|
|
- It's OK to have multiple small commits as you work on the PR - GitHub will automatically squash it before merging.
|
|
|
|
- If adding a new feature:
|
|
- Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first before working on it.
|
|
- Feel free to write a test for it, but so far I didn't have time for that.
|
|
|
|
- If fixing a bug:
|
|
- If you are resolving a special issue, add `(fix #xxxx[,#xxxx])` (#xxxx is the issue id) in your PR title for a better release log, e.g. `update entities encoding/decoding (fix #3899)`.
|
|
- Provide a detailed description of the bug in the PR. Live demo preferred.
|
|
|
|
- You'll need to update the `CHANGELOG.md` with a description of your changes before you open a pull request and your code
|
|
should pass the lint check.
|
|
|
|
## Development Setup
|
|
|
|
You will need [Node.js](http://nodejs.org) **version 8+** and a Chrome browser.
|
|
|
|
After cloning the repo, run:
|
|
|
|
``` bash
|
|
$ npm install
|
|
```
|
|
|
|
The development server can be started with `npm run serve`.
|
|
|
|
### Deploying to GitHub pages or with a non-root path
|
|
|
|
Deploying a forked version to GitHub Pages or running your local
|
|
development copy in a sub-path (instead of the web root) will require you to modify
|
|
the `vue.config.js` and configure the path at which the website will be served, as well
|
|
as removing the CNAME file and updating the GitHub pages configuration. Otherwise, your fork
|
|
will think it should be served at clocktower.online instead of \<user\>.github.io/townsquare/.
|
|
|
|
For example, deploying your forked `townsquare` project to GitHub pages would need the following
|
|
`vue.config.js` changes:
|
|
```js
|
|
module.exports = {
|
|
publicPath: process.env.NODE_ENV === "production" ? "/townsquare/" : "/"
|
|
};
|
|
```
|
|
|
|
### Committing Changes
|
|
|
|
Commit messages should be verbose enough to allow someone else to follow your changes and should include references to issues that are being worked on.
|
|
|
|
### Commonly used NPM scripts
|
|
|
|
``` bash
|
|
# watch and auto re-build dist/
|
|
$ npm run serve
|
|
|
|
# build all dist files, including npm packages
|
|
$ npm run build
|
|
|
|
# run linting scripts
|
|
$ npm run lint
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
- **`dist`**: contains built files for distribution.
|
|
|
|
- **`public`**: static assets and templates that don't need to be built dynamically.
|
|
|
|
- **`server`**: NodeJS code for the live session backend server.
|
|
|
|
- **`src`**: contains the source code. The codebase is written in ES2015.
|
|
|
|
- **`assets`**: contains all graphical assets like images, fonts, icons, etc.
|
|
|
|
- **`editions`**: edition logos and icons
|
|
|
|
- **`fonts`**: webfonts used on the page
|
|
|
|
- **`icons`**: character token icons
|
|
|
|
- **`sounds`**: sound effects used on the page
|
|
|
|
- **`components`**: the internal components used in the project
|
|
|
|
- **`modals`**: the modals have a separate subfolder
|
|
|
|
- **`store`**: the VueX data store and modules
|
|
|
|
- **`modules`**: VueX modules that live in their own namespace
|