75ee6f8b16
Notes: * Will fill in the 'What's new' section after @arcath is finished with his article draft * Will add the legacy branch link when it's available
1.8 KiB
1.8 KiB
Contributing guidelines
This document outlines guides to get started on developing the starter kit.
Contributing to the docs
We welcome contributions to the docs! We're looking for ways to make the starter kit documentation better, as well as many other tips and tricks about Screeps AI development in TypeScript.
You can start working on the docs locally as well. First, you'll need to install the Gitbook CLI.
npm install -g gitbook-cli
To run a local Gitbook server, run the following command on the project's root directory.
gitbook serve
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 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.