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:
- Fork the repository
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push -u origin my-new-feature
- 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 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.