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.
Install node on your system: https://nodejs.org/
$ git clone https://github.com/stt-datacore/website.git
$ npm 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/".
Starts the development server.
$ npm run start
Build the static files into the public
folder.
$ npm run build
This command is shorthand for gatsby serve
npm run serve
Not implmented yet
npm run test
Formats code and docs according to our style guidelines using prettier
npm run format
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.
- Fork the repo.
- Create a branch from
master
. If you're addressing a specific issue, prefix your branch name with the issue number. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Run
npm run test
and ensure the test suite passes. (Not applicable yet) - Use
npm run format
to format and lint your code. - PR's must be rebased before merge (feel free to ask for help).
- PR should be reviewed by at least one maintainer prior to merging.
By contributing to the DataCore project, you agree that your contributions will be licensed under its MIT license.