Skip to content

Commit

Permalink
Merge branch 'master' into fix_issue_1224
Browse files Browse the repository at this point in the history
  • Loading branch information
jespersm committed Sep 5, 2024
2 parents 2a2272e + 3bf9ef0 commit 96f2727
Show file tree
Hide file tree
Showing 486 changed files with 21,355 additions and 13,992 deletions.
6 changes: 6 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
* text eol=lf

# Denote all files that are truly binary and should not be modified.
*.png binary
*.jpg binary
*.gif binary
*.svg binary
72 changes: 72 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Rocket Community Code of Conduct

Like the technical community as a whole, the Rocket project, its teams, and its
community are made up of a mixture of professionals and volunteers from all over
the world, working on every aspect of the mission. Diversity is one of our huge
strengths, but it can also lead to communication issues and unhappiness. To that
end, we have a few ground rules that we ask people to adhere to. This code
applies equally to everyone in our community: maintainers, contributors, team
leads, mentors, those seeking help and guidance, and so on.

This isn’t an exhaustive list of things that you can’t do. Rather, take it in
the spirit in which it’s intended - a guide to make it easier to enrich all of
us and the technical communities in which we participate.

_If you believe someone is violating the code of conduct, we ask that you report
it by emailing [email protected]._

- **Be friendly. Be Kind. Be patient.**

- **Be welcoming.** We strive to be a community that welcomes and supports
everyone, of all backgrounds and identities. This includes, but is not limited
to members of any race, ethnicity, culture, national origin, color,
immigration status, social and economic class, educational level, sex, sexual
orientation, gender identity and expression, age, size, family status,
political belief, religion, and mental and physical ability.

- **Be considerate.** Your work will be used by other people, and you in turn
will depend on the work of others. Any decision you take will affect users and
colleagues, and you should take those consequences into account when making
decisions. Remember that we're a global community, so you might not be
communicating in someone else's primary language.

- **Be respectful.** We won't all agree all the time, but disagreement isn't an
excuse for poor behavior or poor manners. While frustrations may occasionally
arise, we cannot allow those frustrations to turn into personal attacks.
Remember that a community where people feel uncomfortable or threatened is not
a productive one. Be respectful, not just to fellow community members, but to
individuals outside the community as well.

- **Be careful in the words that you choose.** We are a community of
professionals, and we conduct ourselves professionally. Do not insult or put
down other participants. Harassment and other exclusionary behavior aren't
acceptable. This includes, but is not limited to:
- Violent threats or language directed against another person.
- Discriminatory jokes and language.
- Posting sexually explicit or violent material.
- Posting (or threatening to post) other people's personally identifying
information ("doxing").
- Personal insults, especially those using racist or sexist terms.
- Unwelcome sexual attention.
- Advocating for, or encouraging, any of the above behavior.
- Repeated harassment of others. In general, if someone asks you to stop, then
stop.

- **Be understanding.** Disagreements, both social and technical, happen all the
time. It is important that we resolve differing views constructively. When we
disagree, try to understand why. Our community consists of people from a wide
range of backgrounds. Different people have different perspectives on issues.
Being unable to understand why someone holds a viewpoint doesn’t mean that
they’re wrong. Don’t forget that it is human to err; blame accomplishes
nothing. Instead, focus on helping to resolve issues and learning from
mistakes.

_This code of conduct applies to all spaces managed by Rocket or the Rocket Web
Framework Foundation including issues and discussions on GitHub, Matrix, and any
other forums which the community uses for communication._

_This Code of Conduct is adapted from the [Django Code of Conduct]. Original text
from the [Speak Up! project]._

[Django Code of Conduct]: https://www.djangoproject.com/conduct/
[Speak Up! project]: http://web.archive.org/web/20141109123859/http://speakup.io/coc.html
2 changes: 2 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github: rwf2
open_collective: rwf2
28 changes: 0 additions & 28 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

133 changes: 133 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
name: Bug Report
description: Report a functionality issue that deviates from the documentation.
labels: ["triage"]
body:
- type: markdown
attributes:
value: >
**Thanks for taking the time to fill out this bug report!** Your report
helps make Rocket better.
Please only report issues related to _functionality_ that deviates from
published specification or reasonable expectation. Do not report issues
with documentation, infrastructure, or anything unrelated to functional
correctness here.
- type: input
attributes:
label: Rocket Version
description: >
Enter the exact version of Rocket (x.y.z) or git shorthash (8d9dfce) you're using.
Please ensure you're using the latest release before reporting a bug.
placeholder: "ex: 0.5.0"
validations:
required: true
- type: input
attributes:
label: Operating System
description: Which operating system and version are you running?
placeholder: "examples: macOS 13.6.2, Arch Linux 4.16.13"
validations:
required: true
- type: input
attributes:
label: Rust Toolchain Version
description: Which version of `rustc` are you using? (`rustc --version`)
placeholder: "ex: rustc 1.74.0 (79e9716c9 2023-11-13)"
validations:
required: true
- type: textarea
attributes:
label: What happened?
description: Provide a brief overview of what went wrong.
validations:
required: true
- type: textarea
attributes:
label: Test Case
description: >
Provide a Rocket application that elicits the bug. Ideally the program
contains a `#[test]` case using Rocket's
[`local`](https://api.rocket.rs/v0.5/rocket/local/index.html) testing
module.
placeholder: >
#[macro_use] extern crate rocket;
#[launch]
fn rocket() -> _ {
rocket::build()
}
#[test]
fn failing_test() {
use rocket::local::blocking::Client;
let client = Client::tracked(rocket()).unwrap();
let response = client.get("/").dispatch();
assert!(response.status().class().is_success());
}
render: rust
validations:
required: true
- type: textarea
attributes:
label: Log Output
description: >
Please provide the complete log output captured with
`ROCKET_LOG_LEVEL=debug` when the test case is run.
placeholder: >
❯ ROCKET_LOG_LEVEL=debug cargo test
running 1 test
test failing_test ... FAILED
failures:
---- failing_test stdout ----
-- configuration trace information --
>> "address" parameter source: rocket::Config::default()
>> "port" parameter source: rocket::Config::default()
>> "workers" parameter source: rocket::Config::default()
>> "max_blocking" parameter source: rocket::Config::default()
>> "keep_alive" parameter source: rocket::Config::default()
>> "ident" parameter source: rocket::Config::default()
>> "ip_header" parameter source: rocket::Config::default()
>> "limits" parameter source: rocket::Config::default()
>> "temp_dir" parameter source: rocket::Config::default()
>> "log_level" parameter source: `ROCKET_` environment variable(s)
>> "shutdown" parameter source: rocket::Config::default()
>> "cli_colors" parameter source: rocket::Config::default()
🔧 Configured for debug.
>> address: 127.0.0.1
>> port: 8000
[...]
render: shell
validations:
required: true
- type: textarea
attributes:
label: Additional Context
description: >
Feel free to provide any additional context for your bug report.
- type: checkboxes
attributes:
label: System Checks
description: "Please confirm all of the following:"
options:
- label: My bug report relates to functionality.
required: true
- label: I have tested against the latest Rocket release or a recent git commit.
required: true
- label: I have tested against the latest stable `rustc` toolchain.
required: true
- label: I was unable to find this issue previously reported.
required: true
15 changes: 12 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
blank_issues_enabled: true
contact_links:
- name: Question
url: https://github.com/SergioBenitez/Rocket/discussions
about: Please ask questions or raise indefinite concerns on Discussions
- name: FAQ
url: https://rocket.rs/guide/faq/
about: Please see our FAQ for answers to common questions.
- name: Questions
url: https://github.com/rwf2/Rocket/discussions/new?category=questions
about: For other questions or help, please use GitHub discussions.
- name: Feedback
url: https://github.com/rwf2/Rocket/discussions/new/choose
about: For general chat or feedback, please use GitHub discussions.
- name: Chat
url: https://chat.mozilla.org/#/room/#rocket:mozilla.org
about: Chat with us live on rocket:mozilla.org on Matrix.
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/doc-problem.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Documentation Problem
description: Report an issue with or suggest documentation.
labels: ["docs"]
body:
- type: markdown
attributes:
value: >
**Thanks for taking the time to report a documentation issue!**
Documentation problems include everything from typos to missing or
incorrect technical details in any of the following:
- [Rocket's Website](https://rocket.rs/)
- [The Rocket Programming Guide](https://rocket.rs/guide/)
- [API Docs](https://api.rocket.rs)
- [Content on GitHub](https://github.com/rwf2/Rocket)
If we've written it, we want to know how it can be improved.
- type: dropdown
validations:
required: true
attributes:
label: What kind of documentation problem are you reporting?
multiple: true
options:
- Typo (PRs welcome!)
- Unclear Docs
- Undocumented Feature
- Broken Links
- Rendering Issue
- Grammar Issue
- Technical Problem
- Other
- type: input
validations:
required: true
attributes:
label: Where is the issue found?
description: Please provide a direct link to the documentation.
placeholder: "ex: https://rocket.rs/v0.5/guide/requests/#multiple-segments"
- type: textarea
validations:
required: true
attributes:
label: What's wrong?
description: >
Please describe what's wrong with the documentation.
- type: checkboxes
attributes:
label: System Checks
description: "Please confirm all of the following:"
options:
- label: I confirmed that the issue still exists on `master` on GitHub.
required: true
- label: I was unable to find a previous report of this problem.
required: true
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

Loading

0 comments on commit 96f2727

Please sign in to comment.