Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make it simpler to contribute #30

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!--
* Keep your PR:s small and focused.
* The PR title is what ends up in the changelog, so make it descriptive!
* If applicable, add a screenshot or gif.
* If it is a non-trivial addition, consider adding a demo for it to `egui_demo_lib`, or a new example.
* Do NOT open PR:s from your `master` branch, as that makes it hard for maintainers to test and add commits to your PR.
* Remember to run `cargo fmt` and `cargo clippy`.
* Open the PR as a draft until you have self-reviewed it and run `./scripts/check.sh`.
* When you have addressed a PR comment, mark it as resolved.

Please be patient! The PR will be reviewed when someone has time. If you haven't heard anything in a week, feel free to ping the PR.
-->

- Closes <https://github.com/ItsEthra/egui-notify/issues/THE_RELEVANT_ISSUE>
- [ ] I have followed the instructions in the PR template
- [ ] I have run `cargo fmt` and `cargo clippy`
- [ ] I ran `./scripts/check.sh`
2 changes: 1 addition & 1 deletion examples/all.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ impl App for ExampleApp {
ui.checkbox(&mut self.closable, "Closable");
ui.checkbox(&mut self.show_progress_bar, "ShowProgressBar");
if !(self.expires || self.closable) {
ui.label("Warning; toasts will have to be closed programatically");
ui.label("Warning; toasts will have to be closed programmatically");
}
ui.add_enabled_ui(self.expires, |ui| {
ui.horizontal(|ui| {
Expand Down
20 changes: 20 additions & 0 deletions scripts/check.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#!/usr/bin/env bash
# This scripts runs various CI-like checks in a convenient way.

set -eu
script_path=$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P )
cd "$script_path/.."
set -x

cargo install --quiet typos-cli

export RUSTDOCFLAGS="-D warnings"

typos
cargo fmt --all -- --check
cargo clippy --quiet --all-features -- -D warnings
cargo check --quiet --all-targets
cargo test --quiet --all-targets
cargo test --quiet --doc

echo "All checks passed."
Loading