docs: re-arrange files for cleaner structure
This commit is contained in:
committed by
mrugesh mohapatra
parent
5720db294e
commit
0fd3925a08
16
README.md
16
README.md
@ -1,15 +1,5 @@
|
|||||||
# automation
|

|
||||||
|
|
||||||
Scripts for @freeCodeCamp's GitHub automation tasks.
|
# github-tools
|
||||||
|
|
||||||
## Usage
|
Tools to help maintain [freeCodeCamp.org](https://www.freecodecamp.org)'s Open Source Codebase on GitHub
|
||||||
|
|
||||||
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.
|
|
||||||
|
15
docs/CONTRIBUTING.md
Normal file
15
docs/CONTRIBUTING.md
Normal 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.
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@freecodecamp/github-tools",
|
"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,
|
"private": true,
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"postinstall": "lerna bootstrap"
|
"postinstall": "lerna bootstrap"
|
||||||
|
Reference in New Issue
Block a user