From 7ba9f30f37af627f43adc2776c7f39ca3b5889bc Mon Sep 17 00:00:00 2001 From: ChristopherHX Date: Thu, 17 Aug 2023 16:43:17 +0200 Subject: [PATCH] Mention act user guide in act (#1973) * CONTRIBUTING.md mention act user guide * Mention the act user guide in the README --- CONTRIBUTING.md | 2 +- README.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5abe354..f535d2d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,7 +35,7 @@ New issues can be created with in our [GitHub repo](https://github.com/nektos/ac ### Pull Requests -Pull requests should target the `master` branch. Please also reference the issue from the description of the pull request using [special keyword syntax](https://help.github.com/articles/closing-issues-via-commit-messages/) to auto close the issue when the PR is merged. For example, include the phrase `fixes #14` in the PR description to have issue #14 auto close. +Pull requests should target the `master` branch. Please also reference the issue from the description of the pull request using [special keyword syntax](https://help.github.com/articles/closing-issues-via-commit-messages/) to auto close the issue when the PR is merged. For example, include the phrase `fixes #14` in the PR description to have issue #14 auto close. Please send documentation updates for the [act user guide](https://nektosact.com) to [nektos/act-docs](https://github.com/nektos/act-docs). ### Styleguide diff --git a/README.md b/README.md index 8dad0e3..2902a8c 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,10 @@ Let's see it in action with a [sample repo](https://github.com/cplee/github-acti ![Demo](https://github.com/nektos/act/wiki/quickstart/act-quickstart-2.gif) +# Act User Guide + +Please look at the [act user guide](https://nektosact.com) for more documentation. + # Installation ## Necessary prerequisites for running `act`