Help you to contribute (#105)

Author: rlespinasse

.env.template

@@ -0,0 +1,5 @@
+FORKED_ASSIGNEE=YOUR_HANDLE
+FORKED_DEFAULT_BRANCH=main
+FORKED_LABEL="from upstream"
+FORKED_REPOSITORY=YOUR_REPOSITORY/awesome-actions
+UPSTREAM_REPOSITORY=sdras/awesome-actions

.github/linters/.textlintrc

@@ -4,11 +4,11 @@
   "rules": {
     "terminology": {
       "skip": [ "Link" ],
+      "exclude": [
+        "readme(s)?"
+      ],
       "terms": [
         [ "README(s)?", "README$1" ]
-      ],
-      "exclude": [
-        [ "readme(s)?", "readme$1" ]
       ]
     }
   }

.github/workflows/lint.yml

@@ -23,5 +23,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - run: npx awesome-lint
+      - uses: taiki-e/install-action@just
+
+      - run: just awesome-lint
         shell: bash

.github/workflows/linter.yml

@@ -37,4 +37,3 @@ jobs:
           VALIDATE_MARKDOWN_PRETTIER: false
           VALIDATE_JSON_PRETTIER: false
           VALIDATE_GIT_COMMITLINT: false
-          VALIDATE_NATURAL_LANGUAGE: "${{ vars.VALIDATE_NATURAL_LANGUAGE || true }}"

.gitignore

@@ -0,0 +1 @@
+.env

README.md

@@ -444,7 +444,7 @@ Set up your GitHub Actions workflow with a specific version of your programming
 - [Mention Completed Pull Requests in Draft Release](https://github.com/dnbkr/clog)
 - [Recap](https://github.com/flowwer-dev/recap) - Summarize the most significant changes in a pull request using OpenAI ChatGPT.
 - [Semantic Pull Request Composer](https://github.com/mateoguzmana/semantic-pr-composer) - Automatically composes the pull request title and body based on the branch name, which follows a semantic convention. Optional AI autocompletion using OpenAI completions API is also available.
-- [Get Merged Pull Requests](https://github.com/VanOns/get-merged-pull-requests-action) - GitHub action that compares 2 tags and retrieves all pull requests merged between them.
+- [Get Merged Pull Requests](https://github.com/VanOns/get-merged-pull-requests-action) - GitHub Action that compares 2 tags and retrieves all pull requests merged between them.
 - [Catch Performance Regressions in Pull Requests](https://github.com/bencherdev/bencher)
 
 ### GitHub Pages

contributing.md

@@ -36,4 +36,16 @@ Thank you for your suggestions!
 
 Sometimes, we will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the awesome-actions list guidelines.
 
+You can also run some [just](https://just.systems) receipe to help you reduce the editing:
+
+> [!TIP]
+> **prerequisites**
+>
+> - Install the right `just` [package](https://just.systems/man/en/packages.html),
+> - Install the right `node` [package](https://nodejs.org/en/download).
+>
+> Than `just configure` to prepare your local machine.
+
+- `just feedback` to run all related linters on your contribution.
+
 [Here](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) is a write up on how to change a Pull Request, and the different ways you can do that.

justfile

@@ -0,0 +1,47 @@
+#!/usr/bin/env -S just --justfile
+
+set quiet := true
+set dotenv-load := true
+
+default:
+	just --choose
+
+# Configure all needed packages
+[group('Configuration')]
+configure: configure-textlint
+
+# Configure the fork for maintenance
+[group('Configuration')]
+configure-fork:
+    #!/usr/bin/env bash
+    [ ! -f .env ] && cp .env.template .env
+    echo "Adapt your .env to your need :"
+    cat .env
+
+# Install textlint and rules
+[group('Configuration')]
+configure-textlint:
+    npm install textlint -g
+    npm install textlint-rule-terminology -g
+
+# Give feedback on contribution
+[group('Contribution')]
+feedback: awesome-lint textlint
+
+# Run textlint
+[group('Contribution')]
+textlint:
+    textlint -c .github/linters/.textlintrc *
+
+# Run awesome-lint
+[group('Contribution')]
+awesome-lint:
+    npx awesome-lint
+
+# Helper to create a PR in the forked repository taken from the upstream one
+[group('Fork Maintenance')]
+maintain-fork upstream_pr="":
+    gh pr checkout -b {{ upstream_pr }} "https://github.com/${UPSTREAM_REPOSITORY}/pull/{{ upstream_pr }}"
+    git push origin {{ upstream_pr }}
+    gh pr create -a "${FORKED_ASSIGNEE}" -l "${FORKED_LABEL}" -t "$(gh pr view {{ upstream_pr }} --json title --jq '.title')" -b "Linked to ${UPSTREAM_REPOSITORY}#{{ upstream_pr }}" -H {{ upstream_pr }} -B "${FORKED_DEFAULT_BRANCH}" -R "${FORKED_REPOSITORY}"
+    git checkout "${FORKED_DEFAULT_BRANCH}"