Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 1.59 KB

Contributing

Overview

  1. Fork the repo
  2. Make changes
  3. Submit a new Pull Request
  4. Tag @armahillo as a reviewer!

Setup Environment

To view your changes locally:

  1. Install Ruby
  2. Install Jekyll and bundler
  3. Run bundle install
  4. Run bundle exec jekyll serve
  5. Nav to the server address it prints out (should be http://127.0.0.1:4000/)

If you have trouble, Jekyll's docs have good instructions for installing everything.

Worth noting that the serve command watches for file changes, so you shouldn't need to take any build steps after making a change, just refresh your browser.

Guidelines

For bug reports

In your issue, please include the following:

  • Where it happened, citing URL(s) and a general location on the page, if applicable.
  • What you were trying to do
  • How it behaved instead

The better you describe what happened, the better we can reproduce the behavior and identify the cause.

For feature requests

  • What kind of user is this targeted for? (player, publisher, creator, media, etc.)
  • What would you like to see?
  • Is there anything on the site similar to it?
  • What goal / task will this help you accomplish?

For code contributors

  • Branch from main
  • Open pull-request against main
  • In Pull Request description, please cite the issue number. If there isn't already an issue created, please create one (see above!) and cite it.
  • Tag @armahillo as a reviewer

Please be sure to test any changes you make locally (see above!)