Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

33 lines (20 loc) · 1.64 KB

Contributing to Wild Magic Surge 5e

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

There are many ways to contribute to this repository. Each one is equally helpful.

Raising an Issue

If you have found a bug or have an idea for a Feature, please use the Issues functionality in Github. You have two options to create an issue, Bug Report or New Feature.

If the issue you are raising does not fit these criteria, feel free to open a blank issue instead.

Contributing Code

There is nothing better than seeing someone raise a Pull Request against this repository.

To do this

  • fork this repo
  • make changes in your forked repo
  • Ensure the following all pass
    • yarn run lint:check
    • yarn run test
    • yarn run jshint
    • yarn run build

Once you are happy, create Pull Request to this repository from your Fork and I will look through and approve.

The module is built using Typescript and I have a lot of code quality tooling in place to stop me writing loads of bad code. If I pass things back because these things don't pass these standard, please understand this is not to cause any sort of offence. It is important to keep things as standardised and tested as possible.

Thank you for being awesome

John Nolan