Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
28 lines (17 sloc) 1.48 KB

Contributing guidelines

This document outlines guides to get started on developing the starter kit.

Contributing to the docs

Contributions to the docs are also welcome! We've documented the steps to do so here.

The Five Golden Rules

The simple steps of contributing to any GitHub project are as follows:

  1. Fork the repository
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push -u origin my-new-feature
  5. Create a Pull Request!

To keep your fork of in sync with this repository, follow this guide.

Submitting a pull request

We accept almost all pull requests, as long as the following criterias are met:

  • Your code must pass all of the linter checks (npm run lint)
  • When adding a new feature, make sure it doesn't increase the complexity of the tooling. We want this starter kit to be approachable to folks who have little to no knowledge of TypeScript, or even JavaScript.
  • When making changes that are potentially breaking, careful discussion must be done with the community at large. Generally we do this either on the #typescript channel on the Screeps Slack, or on the corresponding pull request discussion thread.