Merge #189

189: Update issue templates r=lnicola a=notriddle Co-authored-by: Michael Howell <[email protected]>
rust-ammonia · Oct 20, 2023 · 98c2eba · 98c2eba
2 parents aa0f8d2 + acf46dd
commit 98c2eba
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 2 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,48 @@
+---
+name: Bug Report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+- [ ] If you used a custom Builder configuration, please supply it here
+
+    ```rust
+    Builder::default()
+        .link_rel(None)
+        .url_relative(UrlRelative::PassThrough)
+    ```
+
+  - [ ] Please supply a reduced version of the *input* HTML that you used with Ammonia
+
+    ```html
+    fill <html> in here
+    ```
+
+  - [ ] If ammonia produced unexpected HTML
+
+      - [ ] Try opening the *input* HTML directly in a WHATWG web browser (like Safari, Edge, Chrome, or Firefox) without sanitizing it.
+
+        If the browser parses it the same way Ammonia does, then it's not a bug.
+
+      - [ ] Supply the reduced *output* HTML here
+
+        ```html
+        output <html> here
+        ```
+
+  - [ ] If Ammonia panics, please provide a backtrace
+
+    ```text
+    $ RUST_BACKTRACE=1 ./test
+    thread 'main' panicked at test.rs:1:17:
+    explicit panic
+    stack backtrace:
+       0: std::panicking::begin_panic
+       1: test::other_fn
+       2: test::main
+       3: core::ops::function::FnOnce::call_once
+    note: Some details are omitted, run with `RUST_BACKTRACE=full` for a verbose backtrace.
+    ```
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**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**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -14,7 +14,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        rust: ["1.60.0", "stable", "beta"]
+        rust: ["1.66.0", "stable", "beta"]
         build_flags: ["", "--cfg ammonia_unstable"]
         os: [ubuntu-latest]
     steps:

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@ HTML Sanitization
 =================
 
 [![Crates.IO](https://img.shields.io/crates/v/ammonia.svg)](https://crates.rs/crates/ammonia)
-![Requires rustc 1.60.0](https://img.shields.io/badge/rustc-1.60.0+-green.svg)
+![Requires rustc 1.60.0](https://img.shields.io/badge/rustc-1.66.0+-green.svg)
 
 Ammonia is a whitelist-based HTML sanitization library. It is designed to
 prevent cross-site scripting, layout breaking, and clickjacking caused