From 8818c10634772fc36441e7d0ff92dda02a647fb8 Mon Sep 17 00:00:00 2001 From: Resi Respati Date: Sat, 23 Dec 2017 15:35:59 +0700 Subject: [PATCH] [docs] updated contributing section --- CONTRIBUTING.md | 16 ++-------------- docs/SUMMARY.md | 2 +- docs/contributing.md | 30 +++++------------------------- 3 files changed, 8 insertions(+), 40 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4a24148..daf5182 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,19 +4,7 @@ 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](https://www.gitbook.com/) CLI. - -```bash -npm install -g gitbook-cli -``` - -To run a local Gitbook server, run the following command on the project's root directory. - -```bash -gitbook serve -``` +Contributions to the docs are also welcome! We've documented the steps to do so [here](./docs/contributing.md). ## The Five Golden Rules @@ -30,7 +18,7 @@ The simple steps of contributing to any GitHub project are as follows: To keep your fork of in sync with this repository, [follow this guide](https://help.github.com/articles/syncing-a-fork/). -## Submitting a Pull Request +## Submitting a pull request We accept almost all pull requests, as long as the following criterias are met: diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index b71ef47..f0ea3c1 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -21,4 +21,4 @@ --- * [Troubleshooting](./troubleshooting.md) -* [Contributing guidelines](./contributing.md) +* [Contributing to the docs](./contributing.md) diff --git a/docs/contributing.md b/docs/contributing.md index 4a24148..a2cfa8e 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,12 +1,12 @@ -# Contributing guidelines +# Contributing to the docs -This document outlines guides to get started on developing the starter kit. +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. If you feel like some parts of the docs need fixing/improving, definitely create a pull request. -## Contributing to the docs +For guidelines on contributing to the starter kit, [click here](https://github.com/screepers/screeps-typescript-starter/blob/master/CONTRIBUTING.md). -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. +## Gitbook -You can start working on the docs locally as well. First, you'll need to install the [Gitbook](https://www.gitbook.com/) CLI. +Our documentation is built using [Gitbook](https://www.gitbook.com/), and are accessible [here](https://screepers.gitbooks.io/screeps-typescript-starter/). You can also start working on the docs locally by installing the Gitbook CLI. ```bash npm install -g gitbook-cli @@ -17,23 +17,3 @@ To run a local Gitbook server, run the following command on the project's root d ```bash gitbook serve ``` - -## The Five Golden Rules - -The simple steps of contributing to any GitHub project are as follows: - -1. [Fork the repository](https://github.com/screepers/screeps-typescript-starter/fork) -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](https://github.com/screepers/screeps-typescript-starter/pulls)! - -To keep your fork of in sync with this repository, [follow this guide](https://help.github.com/articles/syncing-a-fork/). - -## 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](https://screeps.slack.com/messages/typecript/) channel on the Screeps Slack, or on the corresponding pull request discussion thread.