Skip to content

Commit 96f2727

Browse files
committed
Merge branch 'master' into fix_issue_1224
2 parents 2a2272e + 3bf9ef0 commit 96f2727

File tree

486 files changed

+21355
-13992
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

486 files changed

+21355
-13992
lines changed

.gitattributes

+6
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
11
* text eol=lf
2+
3+
# Denote all files that are truly binary and should not be modified.
4+
*.png binary
5+
*.jpg binary
6+
*.gif binary
7+
*.svg binary

.github/CODE_OF_CONDUCT.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Rocket Community Code of Conduct
2+
3+
Like the technical community as a whole, the Rocket project, its teams, and its
4+
community are made up of a mixture of professionals and volunteers from all over
5+
the world, working on every aspect of the mission. Diversity is one of our huge
6+
strengths, but it can also lead to communication issues and unhappiness. To that
7+
end, we have a few ground rules that we ask people to adhere to. This code
8+
applies equally to everyone in our community: maintainers, contributors, team
9+
leads, mentors, those seeking help and guidance, and so on.
10+
11+
This isn’t an exhaustive list of things that you can’t do. Rather, take it in
12+
the spirit in which it’s intended - a guide to make it easier to enrich all of
13+
us and the technical communities in which we participate.
14+
15+
_If you believe someone is violating the code of conduct, we ask that you report
16+
it by emailing [email protected]._
17+
18+
- **Be friendly. Be Kind. Be patient.**
19+
20+
- **Be welcoming.** We strive to be a community that welcomes and supports
21+
everyone, of all backgrounds and identities. This includes, but is not limited
22+
to members of any race, ethnicity, culture, national origin, color,
23+
immigration status, social and economic class, educational level, sex, sexual
24+
orientation, gender identity and expression, age, size, family status,
25+
political belief, religion, and mental and physical ability.
26+
27+
- **Be considerate.** Your work will be used by other people, and you in turn
28+
will depend on the work of others. Any decision you take will affect users and
29+
colleagues, and you should take those consequences into account when making
30+
decisions. Remember that we're a global community, so you might not be
31+
communicating in someone else's primary language.
32+
33+
- **Be respectful.** We won't all agree all the time, but disagreement isn't an
34+
excuse for poor behavior or poor manners. While frustrations may occasionally
35+
arise, we cannot allow those frustrations to turn into personal attacks.
36+
Remember that a community where people feel uncomfortable or threatened is not
37+
a productive one. Be respectful, not just to fellow community members, but to
38+
individuals outside the community as well.
39+
40+
- **Be careful in the words that you choose.** We are a community of
41+
professionals, and we conduct ourselves professionally. Do not insult or put
42+
down other participants. Harassment and other exclusionary behavior aren't
43+
acceptable. This includes, but is not limited to:
44+
- Violent threats or language directed against another person.
45+
- Discriminatory jokes and language.
46+
- Posting sexually explicit or violent material.
47+
- Posting (or threatening to post) other people's personally identifying
48+
information ("doxing").
49+
- Personal insults, especially those using racist or sexist terms.
50+
- Unwelcome sexual attention.
51+
- Advocating for, or encouraging, any of the above behavior.
52+
- Repeated harassment of others. In general, if someone asks you to stop, then
53+
stop.
54+
55+
- **Be understanding.** Disagreements, both social and technical, happen all the
56+
time. It is important that we resolve differing views constructively. When we
57+
disagree, try to understand why. Our community consists of people from a wide
58+
range of backgrounds. Different people have different perspectives on issues.
59+
Being unable to understand why someone holds a viewpoint doesn’t mean that
60+
they’re wrong. Don’t forget that it is human to err; blame accomplishes
61+
nothing. Instead, focus on helping to resolve issues and learning from
62+
mistakes.
63+
64+
_This code of conduct applies to all spaces managed by Rocket or the Rocket Web
65+
Framework Foundation including issues and discussions on GitHub, Matrix, and any
66+
other forums which the community uses for communication._
67+
68+
_This Code of Conduct is adapted from the [Django Code of Conduct]. Original text
69+
from the [Speak Up! project]._
70+
71+
[Django Code of Conduct]: https://www.djangoproject.com/conduct/
72+
[Speak Up! project]: http://web.archive.org/web/20141109123859/http://speakup.io/coc.html

.github/FUNDING.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github: rwf2
2+
open_collective: rwf2

.github/ISSUE_TEMPLATE/bug-report.md

-28
This file was deleted.

.github/ISSUE_TEMPLATE/bug-report.yml

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
name: Bug Report
2+
description: Report a functionality issue that deviates from the documentation.
3+
labels: ["triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
**Thanks for taking the time to fill out this bug report!** Your report
9+
helps make Rocket better.
10+
11+
12+
Please only report issues related to _functionality_ that deviates from
13+
published specification or reasonable expectation. Do not report issues
14+
with documentation, infrastructure, or anything unrelated to functional
15+
correctness here.
16+
- type: input
17+
attributes:
18+
label: Rocket Version
19+
description: >
20+
Enter the exact version of Rocket (x.y.z) or git shorthash (8d9dfce) you're using.
21+
22+
23+
Please ensure you're using the latest release before reporting a bug.
24+
placeholder: "ex: 0.5.0"
25+
validations:
26+
required: true
27+
- type: input
28+
attributes:
29+
label: Operating System
30+
description: Which operating system and version are you running?
31+
placeholder: "examples: macOS 13.6.2, Arch Linux 4.16.13"
32+
validations:
33+
required: true
34+
- type: input
35+
attributes:
36+
label: Rust Toolchain Version
37+
description: Which version of `rustc` are you using? (`rustc --version`)
38+
placeholder: "ex: rustc 1.74.0 (79e9716c9 2023-11-13)"
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: What happened?
44+
description: Provide a brief overview of what went wrong.
45+
validations:
46+
required: true
47+
- type: textarea
48+
attributes:
49+
label: Test Case
50+
description: >
51+
Provide a Rocket application that elicits the bug. Ideally the program
52+
contains a `#[test]` case using Rocket's
53+
[`local`](https://api.rocket.rs/v0.5/rocket/local/index.html) testing
54+
module.
55+
placeholder: >
56+
#[macro_use] extern crate rocket;
57+
58+
59+
#[launch]
60+
61+
fn rocket() -> _ {
62+
rocket::build()
63+
}
64+
65+
66+
#[test]
67+
68+
fn failing_test() {
69+
use rocket::local::blocking::Client;
70+
71+
let client = Client::tracked(rocket()).unwrap();
72+
let response = client.get("/").dispatch();
73+
assert!(response.status().class().is_success());
74+
}
75+
render: rust
76+
validations:
77+
required: true
78+
- type: textarea
79+
attributes:
80+
label: Log Output
81+
description: >
82+
Please provide the complete log output captured with
83+
`ROCKET_LOG_LEVEL=debug` when the test case is run.
84+
placeholder: >
85+
❯ ROCKET_LOG_LEVEL=debug cargo test
86+
87+
running 1 test
88+
89+
test failing_test ... FAILED
90+
91+
failures:
92+
93+
94+
---- failing_test stdout ----
95+
96+
-- configuration trace information --
97+
>> "address" parameter source: rocket::Config::default()
98+
>> "port" parameter source: rocket::Config::default()
99+
>> "workers" parameter source: rocket::Config::default()
100+
>> "max_blocking" parameter source: rocket::Config::default()
101+
>> "keep_alive" parameter source: rocket::Config::default()
102+
>> "ident" parameter source: rocket::Config::default()
103+
>> "ip_header" parameter source: rocket::Config::default()
104+
>> "limits" parameter source: rocket::Config::default()
105+
>> "temp_dir" parameter source: rocket::Config::default()
106+
>> "log_level" parameter source: `ROCKET_` environment variable(s)
107+
>> "shutdown" parameter source: rocket::Config::default()
108+
>> "cli_colors" parameter source: rocket::Config::default()
109+
🔧 Configured for debug.
110+
>> address: 127.0.0.1
111+
>> port: 8000
112+
[...]
113+
render: shell
114+
validations:
115+
required: true
116+
- type: textarea
117+
attributes:
118+
label: Additional Context
119+
description: >
120+
Feel free to provide any additional context for your bug report.
121+
- type: checkboxes
122+
attributes:
123+
label: System Checks
124+
description: "Please confirm all of the following:"
125+
options:
126+
- label: My bug report relates to functionality.
127+
required: true
128+
- label: I have tested against the latest Rocket release or a recent git commit.
129+
required: true
130+
- label: I have tested against the latest stable `rustc` toolchain.
131+
required: true
132+
- label: I was unable to find this issue previously reported.
133+
required: true

.github/ISSUE_TEMPLATE/config.yml

+12-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
blank_issues_enabled: true
22
contact_links:
3-
- name: Question
4-
url: https://github.com/SergioBenitez/Rocket/discussions
5-
about: Please ask questions or raise indefinite concerns on Discussions
3+
- name: FAQ
4+
url: https://rocket.rs/guide/faq/
5+
about: Please see our FAQ for answers to common questions.
6+
- name: Questions
7+
url: https://github.com/rwf2/Rocket/discussions/new?category=questions
8+
about: For other questions or help, please use GitHub discussions.
9+
- name: Feedback
10+
url: https://github.com/rwf2/Rocket/discussions/new/choose
11+
about: For general chat or feedback, please use GitHub discussions.
12+
- name: Chat
13+
url: https://chat.mozilla.org/#/room/#rocket:mozilla.org
14+
about: Chat with us live on rocket:mozilla.org on Matrix.
+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Documentation Problem
2+
description: Report an issue with or suggest documentation.
3+
labels: ["docs"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
**Thanks for taking the time to report a documentation issue!**
9+
10+
11+
Documentation problems include everything from typos to missing or
12+
incorrect technical details in any of the following:
13+
- [Rocket's Website](https://rocket.rs/)
14+
- [The Rocket Programming Guide](https://rocket.rs/guide/)
15+
- [API Docs](https://api.rocket.rs)
16+
- [Content on GitHub](https://github.com/rwf2/Rocket)
17+
18+
If we've written it, we want to know how it can be improved.
19+
- type: dropdown
20+
validations:
21+
required: true
22+
attributes:
23+
label: What kind of documentation problem are you reporting?
24+
multiple: true
25+
options:
26+
- Typo (PRs welcome!)
27+
- Unclear Docs
28+
- Undocumented Feature
29+
- Broken Links
30+
- Rendering Issue
31+
- Grammar Issue
32+
- Technical Problem
33+
- Other
34+
- type: input
35+
validations:
36+
required: true
37+
attributes:
38+
label: Where is the issue found?
39+
description: Please provide a direct link to the documentation.
40+
placeholder: "ex: https://rocket.rs/v0.5/guide/requests/#multiple-segments"
41+
- type: textarea
42+
validations:
43+
required: true
44+
attributes:
45+
label: What's wrong?
46+
description: >
47+
Please describe what's wrong with the documentation.
48+
- type: checkboxes
49+
attributes:
50+
label: System Checks
51+
description: "Please confirm all of the following:"
52+
options:
53+
- label: I confirmed that the issue still exists on `master` on GitHub.
54+
required: true
55+
- label: I was unable to find a previous report of this problem.
56+
required: true

.github/ISSUE_TEMPLATE/feature-request.md

-31
This file was deleted.

0 commit comments

Comments
 (0)