Skip to content

Latest commit

 

History

History
98 lines (62 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

98 lines (62 loc) · 2.41 KB

CONTRIBUTING

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.

If you want to contribute content (CMS pages, BigBook additions, use the website form for a nicer editing interface), or submit PRs here with the MarkDown changes. All information on characters, events and related content is automatically generated from various external sources. Therefore we do not require manual contibutions related to in game content.

If you want to contribute code fixes, see below.

Setup

Install node on your system: https://nodejs.org/

Install dependencies

$ git clone https://github.com/stt-datacore/website.git
$ yarn install

In order to get images on your server you have to run the command.

$ cp .env.default .env

Then change the line "GATSBY_ASSETS_URL=" to "GATSBY_ASSETS_URL=http://assets.datacore.app/".

Available scripts

start

Starts the development server.

Usage

$ yarn run start

build

Build the static files into the public folder.

Usage

$ yarn run build

serve

This command is shorthand for gatsby serve

Usage

yarn run serve

test

Not implmented yet

Usage

yarn run test

format

Formats code and docs according to our style guidelines using prettier

Usage

yarn run format

Pull Requests

We actively welcome your pull requests!

If you need help with Git or our workflow, please ask us. We want your contributions even if you're just learning Git. Our maintainers are happy to help!

PR's should be rebased on master when opened, and again before merging.

  1. Fork the repo.
  2. Create a branch from master. If you're addressing a specific issue, prefix your branch name with the issue number.
  3. If you've added code that should be tested, add tests.
  4. If you've changed APIs, update the documentation.
  5. Run yarn run test and ensure the test suite passes. (Not applicable yet)
  6. Use yarn run format to format and lint your code.
  7. PR's must be rebased before merge (feel free to ask for help).
  8. PR should be reviewed by at least one maintainer prior to merging.

License

By contributing to the DataCore project, you agree that your contributions will be licensed under its MIT license.