chore: setup project after generating from template

.editorconfig

@@ -1,12 +1,15 @@
 root = true
 
 [*]
-indent_style = tab
+indent_style = space
+indent_size = 2
+
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.{md,yml,yaml}]
-indent_style = space
-indent_size = 2
+max_line_length = 120
+
+[*.md]
+trim_trailing_whitespace = false

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @valian-ca/developers

.github/ISSUE_TEMPLATE/bug_report.md

@@ -6,22 +6,22 @@ labels: bug
 assignees: ""
 ---
 
-**Describe the bug**
+## Describe the bug
 
 <!-- A clear and concise description of what the bug is. -->
 
-**Steps to reproduce**
+## Steps to reproduce
 
 <!-- Steps to reproduce the behavior: -->
 
-**Expected behavior**
+## Expected behavior
 
 <!-- A clear and concise description of what you expected to happen. -->
 
-**Screenshots**
+## Screenshots
 
 <!-- If applicable, add screenshots to help explain your problem. -->
 
-**Additional context**
+## Additional context
 
 <!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -6,18 +6,18 @@ labels: enhancement
 assignees: ""
 ---
 
-**Is your feature request related to a problem? Please describe.**
+## Is your feature request related to a problem? Please describe
 
 <!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
 
-**Describe the solution you'd like**
+## Describe the solution you'd like
 
 <!-- A clear and concise description of what you want to happen. -->
 
-**Describe alternatives you've considered**
+## Describe alternatives you've considered
 
 <!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
-**Additional context**
+## Additional context
 
 <!-- Add any other context or screenshots about the feature request here. -->

.github/PULL_REQUEST/pull_request_template.md

@@ -1,3 +1,5 @@
+# Title
+
 <!--- Provide a general summary of your changes in the Title above -->
 
 ## Description

.github/renovate.json5

@@ -0,0 +1,27 @@
+{
+  extends: [
+    'config:recommended',
+    ':pinDependencies',
+    ':pinDevDependencies',
+    'schedule:earlyMondays',
+    ':semanticCommits',
+    ':semanticCommitTypeAll(chore)'
+  ],
+  dependencyDashboard: true,
+  timezone: 'Canada/Eastern',
+  assigneesFromCodeOwners: true,
+  labels: [
+    'dependencies'
+  ],
+  packageRules: [
+    {
+      matchPackagePatterns: [
+        '.*'
+      ],
+      matchManagers: [
+        'github-actions'
+      ],
+      groupName: 'GitHub Actions Dependencies'
+    },
+  ],
+}

.github/settings.yml

@@ -0,0 +1,65 @@
+repository:
+  name: asdf-shorebird
+  description: shorebird plugin for the asdf version manager.
+  topics: asdf-plugin
+
+  private: false
+  is_template: false
+  default_branch: main
+
+  has_issues: true
+  has_wiki: false
+  has_downloads: false
+  has_projects: false
+
+  allow_auto_merge: true
+  allow_squash_merge: true
+  allow_merge_commit: true
+  allow_rebase_merge: false
+  delete_branch_on_merge: true
+  enable_automated_security_fixes: false
+  enable_vulnerability_alerts: true
+
+labels:
+  - name: bug
+    color: '#cc0000'
+    description: Something is broken
+  - name: chore
+    color: '#f2df8c'
+    description: Repository or code maintenance
+  - name: dependencies
+    color: '#70f9e0'
+    description: Update dependencies
+  - name: documentation
+    color: '#6cb524'
+    description: Change in the documentation
+  - name: feature
+    color: '#336699'
+    description: New functionality
+
+teams:
+  - name: developers
+    permission: admin
+
+branches:
+  - name: main
+    protection:
+      required_pull_request_reviews:
+        required_approving_review_count: 1
+        dismiss_stale_reviews: false
+        require_code_owner_reviews: true
+        dismissal_restrictions:
+          users: [ ]
+          teams: [ ]
+      required_status_checks:
+        strict: true
+        contexts:
+          - Lint
+      enforce_admins: false
+      required_linear_history: false
+      required_conversation_resolution: true
+      required_signatures: true
+      restrictions:
+        apps: [ ]
+        users: [ ]
+        teams: [ ]

.gitignore

@@ -0,0 +1,30 @@
+### macOS template
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### JetBrains
+.idea/

.markdownlint.yml

@@ -0,0 +1,7 @@
+default: true
+MD013:
+  line_length: 120
+  code_blocks: true
+MD024:
+  siblings_only: true
+MD034: false

.tool-versions

@@ -1,2 +1,4 @@
+markdownlint-cli2 0.12.1
 shellcheck 0.9.0
 shfmt 3.6.0
+yamllint 1.32.0

.yamllint.yml

@@ -0,0 +1,6 @@
+extends: relaxed
+
+rules:
+  line-length:
+    max: 120
+    level: warning

CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Contributing
+
+Contributions are welcome!
+
+1. Install tools:
+
+   ```shell
+   asdf plugin add shellcheck
+   asdf plugin add shfmt
+   asdf install
+   ```
+
+2. Make changes
+3. Test
+
+   ```shell
+   asdf plugin test shorebird https://github.com/valian-ca/asdf-shorebird.git "shorebird --version"
+   ```
+
+4. Lint & format:
+
+   ```shell
+   ./scripts/format.bash
+   ./scripts/lint.bash
+   ```
+
+5. Open PR
+
+Tests are automatically run in GitHub Actions on push and PR.

README.md

@@ -1,26 +1,22 @@
-<div align="center">
+# asdf-shorebird
 
-# asdf-shorebird [![Build](https://github.com/johnmartel/asdf-shorebird/actions/workflows/build.yml/badge.svg)](https://github.com/johnmartel/asdf-shorebird/actions/workflows/build.yml) [![Lint](https://github.com/johnmartel/asdf-shorebird/actions/workflows/lint.yml/badge.svg)](https://github.com/johnmartel/asdf-shorebird/actions/workflows/lint.yml)
+[![Build](https://github.com/valian-ca/asdf-shorebird/actions/workflows/build.yml/badge.svg)](https://github.com/valian-ca/asdf-shorebird/actions/workflows/build.yml)
+[![Lint](https://github.com/valian-ca/asdf-shorebird/actions/workflows/lint.yml/badge.svg)](https://github.com/valian-ca/asdf-shorebird/actions/workflows/lint.yml)
 
 [shorebird](https://docs.shorebird.dev/) plugin for the [asdf version manager](https://asdf-vm.com).
 
-</div>
-
-# Contents
+## Contents
 
 - [Dependencies](#dependencies)
 - [Install](#install)
 - [Contributing](#contributing)
 - [License](#license)
 
-# Dependencies
-
-**TODO: adapt this section**
+## Dependencies
 
 - `bash`, `curl`, `tar`, and [POSIX utilities](https://pubs.opengroup.org/onlinepubs/9699919799/idx/utilities.html).
-- `SOME_ENV_VAR`: set this environment variable in your shell config to load the correct version of tool x.
 
-# Install
+## Install
 
 Plugin:
 
@@ -49,12 +45,12 @@ shorebird --version
 Check [asdf](https://github.com/asdf-vm/asdf) readme for more instructions on how to
 install & manage versions.
 
-# Contributing
+## Contributing
 
-Contributions of any kind welcome! See the [contributing guide](contributing.md).
+Contributions of any kind welcome! See the [contributing guide](CONTRIBUTING.md).
 
-[Thanks goes to these contributors](https://github.com/johnmartel/asdf-shorebird/graphs/contributors)!
+[Thanks goes to these contributors](https://github.com/valian-ca/asdf-shorebird/graphs/contributors)!
 
-# License
+## License
 
-See [LICENSE](LICENSE) © [John Martel](https://github.com/johnmartel/)
+See [LICENSE](LICENSE) © [VALIAN](https://github.com/valian-ca/)

scripts/lint.bash

@@ -7,3 +7,7 @@ shellcheck --shell=bash --external-sources \
 
 shfmt --language-dialect bash --diff \
 	./**/*
+
+markdownlint-cli2 "**/*.md"
+
+yamllint .