Skip to content

Commit

Permalink
style: apply markdown-lint
Browse files Browse the repository at this point in the history
  • Loading branch information
lotyp committed Apr 24, 2024
1 parent 6e60616 commit 77c7049
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 31 deletions.
6 changes: 3 additions & 3 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
reported by contacting the project team at <[email protected]>. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand All @@ -68,9 +68,9 @@ members of the project's leadership.
## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
<https://www.contributor-covenant.org/faq>
25 changes: 12 additions & 13 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,18 @@ Before you begin, you will need to set up your local development environment. He

- **Operating System**: macOS Monterey+, Linux, or Windows with WSL2.
- **Docker**: Version 26.0.0 or newer. Installation guides:
- [Docker on Ubuntu 22.04](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-22-04)
- [Docker Desktop on Mac](https://docs.docker.com/desktop/install/mac-install/)
- [Docker on Ubuntu 22.04](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-22-04)
- [Docker Desktop on Mac](https://docs.docker.com/desktop/install/mac-install/)
- **Homebrew** (macOS only): Install via [brew.sh](https://brew.sh/).

### → Optional Tools

- [Pre-commit](https://pre-commit.com) — Automates the running of git pre-commit hooks.
- Installation: `brew install pre-commit` and `make hooks`
- Installation: `brew install pre-commit` and `make hooks`
- [Cz-git](https://cz-git.qbb.sh) — Commitizen adapter, that assists in formatting git commits.
- Installation: `brew install czg`
- Installation: `brew install czg`
- [Act](https://github.com/nektos/act) — To run and test GitHub actions locally.
- Installation: `brew install act`

- Installation: `brew install act`

<br>

Expand All @@ -35,7 +34,7 @@ This project uses a Makefile to streamline common development tasks. The Makefil
Refer to the output of `make help` for a comprehensive list of available commands.

```bash
$ make help
make help
```

![Screenshot](../assets/screenshot.png)
Expand Down Expand Up @@ -67,15 +66,15 @@ Our project employs [GitHub Actions](https://github.com/features/actions) for co

<br>

## ✉️ Commit Message Guidelines
## 📩 Commit Message Guidelines

We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard. Please structure your commit messages as follows, using the appropriate prefix:

**Examples:**

```bash
$ git commit -am 'feat: some feature was introduced'
$ git commit -am 'fix: something has been fixed'
git commit -am 'feat: some feature was introduced'
git commit -am 'fix: something has been fixed'
```

**Allowed Prefixes:**
Expand Down Expand Up @@ -109,7 +108,7 @@ We use [`yamllint`](https://github.com/adrienverge/yamllint) to enforce coding s
To lint yaml files run:

```bash
$ make lint-yaml
make lint-yaml
```

by default, [`cytopia/yamllint`](https://github.com/cytopia/docker-yamllint) Docker image will be used to run linter.
Expand All @@ -121,7 +120,7 @@ We use [`actionlint`](https://github.com/rhysd/actionlint) to enforce coding sta
To lint GitHub Actions run:

```bash
$ make lint-actions
make lint-actions
```

by default, [`rhysd/actionlint`](https://hub.docker.com/r/rhysd/actionlint/tags) Docker image will be used to run linter.
Expand All @@ -146,7 +145,7 @@ Our pre-commit configuration includes several hooks:
To utilize these hooks, you first need to install them using the command provided by the Makefile:

```bash
$ make hooks
make hooks
```

<br>
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ lint-actions: ## Lint all github actions
.PHONY: lint-actions

lint-md: ## Lint all markdown files using markdownlint-cli2
@$(MARKDOWN_LINT_RUNNER) --fix "**/*.md" | tee -a $(MAKE_LOGFILE)
@$(MARKDOWN_LINT_RUNNER) --fix "**/*.md" "#CHANGELOG.md" | tee -a $(MAKE_LOGFILE)
.PHONY: lint-md

lint-md-dry: ## Lint all markdown files using markdownlint-cli2 in dry-run mode
Expand Down
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ These tools encapsulate common and repetitive tasks, allowing for easy integrati
- [Security Policy](#-security-policy)
- [Contributing](#-want-to-contribute)
- [Social Links](#-social-links)
- [Author Information](#-author-information)
- [Useful Resources](#-useful-resources)
- [Contributors](#-contributors)

Expand All @@ -53,7 +52,7 @@ To use these workflows and actions, reference them directly from your project's

<br>

## ⚙️ Composite Actions
## 💻 Composite Actions

Composite Actions are a powerful feature of GitHub Actions that allow you to create reusable actions using a combination of other actions, shell commands, or both.

Expand All @@ -72,7 +71,7 @@ Check each action's README file for detailed instructions on how to use it.

<br>

## ⚙️ Workflows
## 💻 Workflows

Read more about [reusing workflows](https://docs.github.com/en/actions/using-workflows/reusing-workflows).

Expand All @@ -84,7 +83,7 @@ Automatically applies labels to pull requests based on modified paths.

This workflow triages pull requests and applies labels based on the paths that are modified in the pull request. This can help to categorize your pull requests and make it easier to identify the type of changes included.

To use this workflow, set up a `.github/labeler.yml` file with your configuration in your project. For more information on how to configure the labeler, see: https://github.com/actions/labeler/blob/master/README.md
To use this workflow, set up a `.github/labeler.yml` file with your configuration in your project. For more information on how to configure the labeler, see: <https://github.com/actions/labeler/blob/master/README.md>

Here is an example of how to use this workflow:

Expand Down Expand Up @@ -133,6 +132,7 @@ jobs:

...
```

</details>

Real-world examples can be found in the [`wayofdev/laravel-package-tpl`](https://github.com/wayofdev/laravel-package-tpl/blob/master/.github/workflows/apply-labels.yml) repository.
Expand Down Expand Up @@ -174,6 +174,7 @@ jobs:

...
```

</details>

Real-world examples can be found in the [`wayofdev/laravel-package-tpl`](https://github.com/wayofdev/laravel-package-tpl/blob/master/.github/workflows/auto-merge-release.yml) repository.
Expand Down Expand Up @@ -221,6 +222,7 @@ jobs:

...
```

</details>

Real-world examples can be found in the [`wayofdev/laravel-package-tpl`](https://github.com/wayofdev/laravel-package-tpl/blob/master/.github/workflows/create-arch-diagram.yml) repository.
Expand Down Expand Up @@ -260,6 +262,7 @@ jobs:

...
```

</details>

Real-world examples can be found in the [`wayofdev/laravel-package-tpl`](https://github.com/wayofdev/laravel-package-tpl/blob/master/.github/workflows/shellcheck.yml) repository.
Expand Down Expand Up @@ -300,13 +303,13 @@ You are more than welcome. Before contributing, kindly check our [contribution g

## 🧱 Useful Resources

* [Composite Actions vs Reusable Workflows: what is the difference?](https://dev.to/n3wt0n/composite-actions-vs-reusable-workflows-what-is-the-difference-github-actions-11kd)
- [Composite Actions vs Reusable Workflows: what is the difference?](https://dev.to/n3wt0n/composite-actions-vs-reusable-workflows-what-is-the-difference-github-actions-11kd)

* [wayofdev/gh-actions](https://github.com/wayofdev/gh-actions) — Upstream repository for the shared GitHub Actions.
- [wayofdev/gh-actions](https://github.com/wayofdev/gh-actions) — Upstream repository for the shared GitHub Actions.

* [ergebnis/.github](https://github.com/ergebnis/.github) — Shareable actions of the [@ergebnis](https://github.com/ergebnis) organization.
- [ergebnis/.github](https://github.com/ergebnis/.github) — Shareable actions of the [@ergebnis](https://github.com/ergebnis) organization.

* [skills/reusable-workflows](https://github.com/skills/reusable-workflows) — Reusable workflow examples
- [skills/reusable-workflows](https://github.com/skills/reusable-workflows) — Reusable workflow examples

<br>

Expand Down
7 changes: 4 additions & 3 deletions actions/composer/install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,18 +97,19 @@ none
- When `dependencies` is set to `"lowest"`, dependencies are installed in the directory specified by `working-directory` with

```bash
$ composer update --ansi --no-interaction --no-progress --prefer-lowest
composer update --ansi --no-interaction --no-progress --prefer-lowest
````

- When `dependencies` is set to `"locked"`, dependencies are installed in the directory specified by `working-directory` with

```bash
$ composer install --ansi --no-interaction --no-progress
composer install --ansi --no-interaction --no-progress
```

- When `dependencies` is set to `"highest"`, dependencies are installed in the directory specified by `working-directory` with

```bash
$ composer update --ansi --no-interaction --no-progress
composer update --ansi --no-interaction --no-progress
````
<br>
6 changes: 3 additions & 3 deletions actions/phive/install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,17 +85,17 @@ none
- When `dependencies` is set to `"lowest"`, dependencies are installed in the directory specified by `working-directory` with

```bash
$ composer update --ansi --no-interaction --no-progress --prefer-lowest
composer update --ansi --no-interaction --no-progress --prefer-lowest
````

- ```bash
$ composer install --ansi --no-interaction --no-progress
composer install --ansi --no-interaction --no-progress
```

- When `dependencies` is set to `"highest"`, dependencies are installed in the directory specified by `working-directory` with

```bash
$ composer update --ansi --no-interaction --no-progress
composer update --ansi --no-interaction --no-progress
````
<br>

0 comments on commit 77c7049

Please sign in to comment.