docs: re-arrange files for cleaner structure

This commit is contained in:
Mrugesh Mohapatra
2018-12-05 05:04:59 +05:30
committed by mrugesh mohapatra
parent 5720db294e
commit 0fd3925a08
3 changed files with 19 additions and 14 deletions

View File

@ -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

15
docs/CONTRIBUTING.md Normal file
View File

@ -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.

View File

@ -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"