From f5eda6caff3030361bc18742eae8fc8d311a8b05 Mon Sep 17 00:00:00 2001 From: TESTELIN Geoffrey Date: Thu, 11 Feb 2021 22:52:46 +0100 Subject: [PATCH] docs: move the contribution section to a dedicated file add more content to help the debug --- CONTRIBUTING.md | 19 +++++++++++++++++++ README.md | 30 +++++++++--------------------- 2 files changed, 28 insertions(+), 21 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..34b5a69d6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +### Building and testing + +Install the dependencies. + +```bash +$ npm install +``` + +Build the typescript and package it for distribution. + +```bash +$ npm run build && npm run pack +``` + +Run the tests :heavy_check_mark: + +```bash +$ npm test +``` diff --git a/README.md b/README.md index 73d315111..7d21c3cba 100644 --- a/README.md +++ b/README.md @@ -2,26 +2,6 @@ Warns and then closes issues and PRs that have had no activity for a specified amount of time. -### Building and testing - -Install the dependencies - -```bash -$ npm install -``` - -Build the typescript and package it for distribution - -```bash -$ npm run build && npm run pack -``` - -Run the tests :heavy_check_mark: - -```bash -$ npm test -``` - ### Arguments | Input | Description | Usage | @@ -224,4 +204,12 @@ jobs: ### Debugging -To see debug output from this action, you must set the secret `ACTIONS_STEP_DEBUG` to `true` in your repository. You can run this action in debug only mode (no actions will be taken on your issues) by passing `debug-only` `true` as an argument to the action. +To see the debug output from this action, you must set the secret `ACTIONS_STEP_DEBUG` to `true` in your repository. +You can run this action in debug only mode (no actions will be taken on your issues and pull requests) by passing `debug-only` to `true` as an argument to the action. +You can also increase the maximum number of operations per run by passing `operations-per-run` to `100` for example. +Finally, you could also change the cron job frequency in the stale workflow to run stale more often. + +### Contributing + +You wish to contribute? +Check out the [contributing](CONTRIBUTING.md) file before helping us.