Add repository badges and issue template (#2)

* Optimize CI workflow with path filtering

* Add issue template

* Update README

Author: gonzalezreal

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,73 @@
+name: Bug Report
+description: Something isn't working as expected
+labels: [bug]
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thank you for contributing to Textual!
+
+      Before you submit your issue, please complete each text area below with the relevant details for your bug, and complete the steps in the checklist.
+- type: textarea
+  attributes:
+    label: Description
+    description: |
+      A short description of the incorrect behavior.
+
+      If you think this issue has been recently introduced and did not occur in an earlier version, please note that. If possible, include the last version that the behavior was correct in addition to your current version.
+  validations:
+    required: true
+- type: checkboxes
+  attributes:
+    label: Checklist
+    options:
+    - label: I have determined whether this bug is also reproducible in a vanilla SwiftUI project.
+      required: false
+    - label: If possible, I've reproduced the issue using the `main` branch of this package.
+      required: false
+    - label: This issue hasn't been addressed in an [existing GitHub issue](https://github.com/gonzalezreal/textual/issues) or [discussion](https://github.com/gonzalezreal/textual/discussions).
+      required: true
+- type: textarea
+  attributes:
+    label: Expected behavior
+    description: Describe what you expected to happen.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Actual behavior
+    description: Describe or copy/paste the behavior you observe.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Steps to reproduce
+    description: |
+      Explanation of how to reproduce the incorrect behavior.
+
+      This could include an attached project or link to code that is exhibiting the issue, and/or a screen recording.
+    placeholder: |
+      1. ...
+  validations:
+    required: false
+- type: input
+  attributes:
+    label: Textual version information
+    description: The version of Textual used to reproduce this issue.
+    placeholder: "'0.1.0' for example, or a commit hash"
+- type: input
+  attributes:
+    label: Destination operating system
+    description: The OS running your application.
+    placeholder: "'iOS 18' or 'macOS 15' for example"
+- type: input
+  attributes:
+    label: Xcode version information
+    description: The version of Xcode used to reproduce this issue.
+    placeholder: "The version displayed from 'Xcode > About Xcode'"
+- type: textarea
+  attributes:
+    label: Swift Compiler version information
+    description: The version of Swift used to reproduce this issue.
+    placeholder: Output from 'xcrun swiftc --version'
+    render: shell

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,9 @@
+blank_issues_enabled: false
+
+contact_links:
+  - name: Discussion
+    url: https://github.com/gonzalezreal/textual/discussions
+    about: Textual Q&A, ideas, and feature requests
+  - name: Documentation
+    url: https://github.com/gonzalezreal/textual#readme
+    about: Read documentation and examples for Textual

.github/workflows/ci.yml

@@ -4,9 +4,25 @@ on:
   push:
     branches:
       - main
+    paths-ignore:
+      - '**.md'
+      - 'LICENSE*'
+      - '.gitignore'
+      - '.editorconfig'
+      - '**.gif'
+      - '**.png'
+      - '**.jpg'
   pull_request:
     branches:
       - '*'
+    paths-ignore:
+      - '**.md'
+      - 'LICENSE*'
+      - '.gitignore'
+      - '.editorconfig'
+      - '**.gif'
+      - '**.png'
+      - '**.jpg'
   workflow_dispatch:
 
 concurrency:

README.md

@@ -1,12 +1,14 @@
 # Textual
-<!-- TODO: CI badge -->
-<!-- TODO: SPI badges -->
+[![CI](https://github.com/gonzalezreal/textual/workflows/CI/badge.svg)](https://github.com/gonzalezreal/textual/actions?query=workflow%3ACI)
+[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fgonzalezreal%2Ftextual%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/gonzalezreal/textual)
+[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fgonzalezreal%2Ftextual%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/gonzalezreal/textual)
 
 Render and customize rich attributed text in SwiftUI.
 
 - [Overview](#overview)
 - [Getting Started](#getting-started)
 - [Demos](#demos)
+- [Documentation](#documentation)
 - [Installation](#installation)
 - [License](#license)
 
@@ -286,6 +288,10 @@ to explore and reference.
 The demo lives in [`Examples/TextualDemo`](./Examples/TextualDemo) and is included in `Textual.xcworkspace` at the
 repository root. Open the workspace to browse the library source and run the demo side-by-side.
 
+## Documentation
+
+The latest documentation for Textual is available [here](https://swiftpackageindex.com/gonzalezreal/textual/main/documentation/textual).
+
 ## Installation
 
 You can add Textual to an Xcode project by adding it to your project as a package.