From 0fd3925a088085a744a1ede66ac26a4ea55d1cc3 Mon Sep 17 00:00:00 2001 From: Mrugesh Mohapatra Date: Wed, 5 Dec 2018 05:04:59 +0530 Subject: [PATCH] docs: re-arrange files for cleaner structure --- README.md | 16 +++------------- docs/CONTRIBUTING.md | 15 +++++++++++++++ package.json | 2 +- 3 files changed, 19 insertions(+), 14 deletions(-) create mode 100644 docs/CONTRIBUTING.md diff --git a/README.md b/README.md index c076343032..e0f0aac387 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,5 @@ -# automation +![freeCodeCamp Social Banner](https://s3.amazonaws.com/freecodecamp/wide-social-banner.png) -Scripts for @freeCodeCamp's GitHub automation tasks. +# github-tools -## Usage - -Todo - -## Caveat - -The automation scripts will error out on actions performed by repository admins, for example: - -> If an admin removes a label from a Pull request, the script can not add that label back. This is usually because the script is acting on behalf of a non-admin user with write access. -> -> This is usually the case with the use of access tokens for scripts. +Tools to help maintain [freeCodeCamp.org](https://www.freecodecamp.org)'s Open Source Codebase on GitHub diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000000..8f54162427 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing + +Todo + +## Usage + +Todo + +## Caveat + +The one-off scripts will error out on actions performed by repository admins, for example: + +> If an admin removes a label from a Pull request, the script can not add that label back. This is usually because the script is acting on behalf of a non-admin user with write access. +> +> This is usually the case with the use of access tokens for scripts. diff --git a/package.json b/package.json index 3aa0db9756..3b197779e1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@freecodecamp/github-tools", - "description": "freeCodeCamp.org's tools for helping maintain its Open Source codebase", + "description": "Tools to help maintain freecodecamp.org's Open Source Codebase on GitHub", "private": true, "scripts": { "postinstall": "lerna bootstrap"