Skip to content

Commit 98c2eba

Browse files
bors[bot]notriddle
andauthored
Merge #189
189: Update issue templates r=lnicola a=notriddle Co-authored-by: Michael Howell <michael@notriddle.com>
2 parents aa0f8d2 + acf46dd commit 98c2eba

File tree

4 files changed

+67
-2
lines changed

4 files changed

+67
-2
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
- [ ] If you used a custom Builder configuration, please supply it here
11+
12+
```rust
13+
Builder::default()
14+
.link_rel(None)
15+
.url_relative(UrlRelative::PassThrough)
16+
```
17+
18+
- [ ] Please supply a reduced version of the *input* HTML that you used with Ammonia
19+
20+
```html
21+
fill <html> in here
22+
```
23+
24+
- [ ] If ammonia produced unexpected HTML
25+
26+
- [ ] Try opening the *input* HTML directly in a WHATWG web browser (like Safari, Edge, Chrome, or Firefox) without sanitizing it.
27+
28+
If the browser parses it the same way Ammonia does, then it's not a bug.
29+
30+
- [ ] Supply the reduced *output* HTML here
31+
32+
```html
33+
output <html> here
34+
```
35+
36+
- [ ] If Ammonia panics, please provide a backtrace
37+
38+
```text
39+
$ RUST_BACKTRACE=1 ./test
40+
thread 'main' panicked at test.rs:1:17:
41+
explicit panic
42+
stack backtrace:
43+
0: std::panicking::begin_panic
44+
1: test::other_fn
45+
2: test::main
46+
3: core::ops::function::FnOnce::call_once
47+
note: Some details are omitted, run with `RUST_BACKTRACE=full` for a verbose backtrace.
48+
```
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
runs-on: ${{ matrix.os }}
1515
strategy:
1616
matrix:
17-
rust: ["1.60.0", "stable", "beta"]
17+
rust: ["1.66.0", "stable", "beta"]
1818
build_flags: ["", "--cfg ammonia_unstable"]
1919
os: [ubuntu-latest]
2020
steps:

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ HTML Sanitization
22
=================
33

44
[![Crates.IO](https://img.shields.io/crates/v/ammonia.svg)](https://crates.rs/crates/ammonia)
5-
![Requires rustc 1.60.0](https://img.shields.io/badge/rustc-1.60.0+-green.svg)
5+
![Requires rustc 1.60.0](https://img.shields.io/badge/rustc-1.66.0+-green.svg)
66

77
Ammonia is a whitelist-based HTML sanitization library. It is designed to
88
prevent cross-site scripting, layout breaking, and clickjacking caused

0 commit comments

Comments
 (0)