fossabot/pips

Pips are dots indicating a unit of numerical value on dice or dominoes

Pips

Pips are dots indicating a unit of numerical value on dice or dominoes

A tiny service which returns dice rolls for a given d20 string (ex: "1d6")

Getting Started

Prerequisites

NodeJS is required. It can be installed here.

This project uses yarn in place of npm. Follow these instructions to install yarn globally.

Warning: Windows users should not install yarn via NPM, instead use the downloadable MSI executable.

Once installed, yarn is used to install all dependencies.

yarn install

Local Development

yarn develop

Running

yarn build
yarn start

Testing

yarn test

Contributing

Make sure you have tslint installed globally. This project is linted before each build. All code contributions should have zero linting errors.

Also, install EditorConfig in your editor. This will help keep a consistent code style throughout the project.

This project makes use of GitHub Flow. As such, work should be done on a feature branch and a pull request opened against master once the work is complete. Feature branches should following the naming convention feature/<feature-name>.

Pull Request Process

Pull requests will undergo a technical and functional review. After both reviews have passed, and given that the base and feature branches are correct (as stated above), the pull request will be merged by the maintainer.

Issues

• Before opening a new GitHub issue, please search the existing issues to see if it has already been reported.
• When opening a new issue, please provide as much detail as possible, including, but not limited to: the full error message, file name and line number, and steps to reproduce.
• Please avoid adding "+1" comments to issues. Instead, add the 👍 reaction to the orignal issue message.

Versioning

Version numbers will follow SemVer versioning:

Major.Minor.Patch

For example, this is a valid version number:

1.2.345

Any changes that affect the major, minor, or patch versioning should have a tag pushed to origin with the SemVer version (consisting of major, minor, and patch). For example, if the project was at version 0.1.0 and it was decided that it was ready for official release, the tag 1.0.0 would be pushed to origin at that commit.

License

MIT