Skip to content

Commit

Permalink
meta: toolchains & templates (#110)
Browse files Browse the repository at this point in the history
* chore(tools): add rustfmt / toolchain

Signed-off-by: Daniel Thompson-Yvetot <[email protected]>

* chore(.github)

Signed-off-by: Daniel Thompson-Yvetot <[email protected]>

* chore(workflows): audit, clippy, fmt, udeps

Signed-off-by: Daniel Thompson-Yvetot <[email protected]>

* Remove some files for simplicity

* cargo fmt

* cargo clippy

* Remove clippy ci check

There are several rules violate clippy but we use it for debug and compatibility for system api. So we have to remove it.

Co-authored-by: Ngo Iok Ui <[email protected]>
  • Loading branch information
nothingismagick and Ngo Iok Ui authored Mar 9, 2021
1 parent d416033 commit fae4bbc
Show file tree
Hide file tree
Showing 32 changed files with 2,903 additions and 2,726 deletions.
14 changes: 14 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Current WG Code Sub Teams:
# @tauri-apps/admins
# @tauri-apps/core
# @tauri-apps/testing

# admins default to review
# Order is important; the last matching pattern takes the most precedence.
* @tauri-apps/admins

.github @tauri-apps/admins @tauri-apps/testing

/examples/ @tauri-apps/testing

/src/ @tauri-apps/core
13 changes: 13 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Contributor Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.

Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
44 changes: 44 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Tauri Contributing Guide

Hi! We, the maintainers, are really excited that you are interested in contributing to Tauri. Before submitting your contribution though, please make sure to take a moment and read through the [Code of Conduct](CODE_OF_CONDUCT.md), as well as the appropriate section for the contribution you intend to make:

- [Issue Reporting Guidelines](#issue-reporting-guidelines)
- [Pull Request Guidelines](#pull-request-guidelines)
- [Development Guide](#development-guide)

## Issue Reporting Guidelines

- The issue list of this repo is **exclusively** for bug reports and feature requests. Non-conforming issues will be closed immediately.

- If you have a question, you can get quick answers from the [Tauri Discord chat](https://discord.gg/SpmNs4S).

- Try to search for your issue, it may have already been answered or even fixed in the development branch (`dev`).

- Check if the issue is reproducible with the latest stable version of Tauri. If you are using a pre-release, please indicate the specific version you are using.

- It is **required** that you clearly describe the steps necessary to reproduce the issue you are running into. Although we would love to help our users as much as possible, diagnosing issues without clear reproduction steps is extremely time-consuming and simply not sustainable.

- Use only the minimum amount of code necessary to reproduce the unexpected behavior. A good bug report should isolate specific methods that exhibit unexpected behavior and precisely define how expectations were violated. What did you expect the method or methods to do, and how did the observed behavior differ? The more precisely you isolate the issue, the faster we can investigate.

- Issues with no clear repro steps will not be triaged. If an issue labeled "need repro" receives no further input from the issue author for more than 5 days, it will be closed.

- If your issue is resolved but still open, don’t hesitate to close it. In case you found a solution by yourself, it could be helpful to explain how you fixed it.

- Most importantly, we beg your patience: the team must balance your request against many other responsibilities — fixing other bugs, answering other questions, new features, new documentation, etc. The issue list is not paid support and we cannot make guarantees about how fast your issue can be resolved.

## Pull Request Guidelines

- It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging.

- If adding new feature:

- Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it.

- If fixing a bug:
- If you are resolving a special issue, add `(fix: #xxxx[,#xxx])` (#xxxx is the issue id) in your PR title for a better release log, e.g. `fix: update entities encoding/decoding (fix #3899)`.
- Provide detailed description of the bug in the PR, or link to an issue that does.


## Financial Contribution

Tauri is an MIT-licensed open source project. Its ongoing development can be supported via [Github Sponsors](https://github.com/sponsors/nothingismagick) or [Open Collective](https://opencollective.com/tauri). We prefer Github Sponsors as donations made are doubled through the matching fund program.
8 changes: 8 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# These are supported funding model platforms

github: #
patreon: #
open_collective: tauri
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
custom: # Replace with a single custom sponsorship URL
36 changes: 36 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!--
Please make sure to read the Pull Request Guidelines:
https://github.com/tauri-apps/tauri/blob/dev/.github/CONTRIBUTING.md#pull-request-guidelines
-->

<!-- PULL REQUEST TEMPLATE -->
<!-- (Update "[ ]" to "[x]" to check a box) -->

**What kind of change does this PR introduce?** (check at least one)

- [ ] Bugfix
- [ ] Feature
- [ ] Code style update
- [ ] Refactor
- [ ] Documentation
- [ ] Build-related changes
- [ ] Other, please describe:

**Does this PR introduce a breaking change?** (check one)
<!--
If yes, please describe the impact and migration path for existing applications in an attached issue. Filing a PR with breaking changes that has not been discussed and approved by the maintainers in an issue will be immediately closed.
-->

- [ ] Yes. Issue #___
- [ ] No


**The PR fulfills these requirements:**

- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `fix: #xxx[,#xxx]`, where "xxx" is the issue number)
- [ ] A change file is added if any packages will require a version bump due to this PR per [the instructions in the readme](https://github.com/tauri-apps/tauri/blob/dev/.changes/readme.md).

If adding a **new feature**, the PR's description includes:
- [ ] A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

**Other information:**
20 changes: 20 additions & 0 deletions .github/workflows/audit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Audit

on:
workflow_dispatch:
schedule:
- cron: '0 0 * * *'
push:
paths:
- "Cargo.lock"
- "Cargo.toml"

jobs:
audit-rust:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: rust audit
uses: actions-rs/audit-check@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
24 changes: 24 additions & 0 deletions .github/workflows/fmt.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: fmt check

on:
pull_request:
paths:
- 'src/**'
- 'Cargo.toml'

jobs:
clippy_fmt_check:
runs-on: macos-latest

steps:
- uses: actions/checkout@v2
- uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: nightly
override: true
components: rustfmt
- uses: actions-rs/cargo@v1
with:
command: fmt
args: --all -- --check
19 changes: 19 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Security Policy

## Supported Versions

| Version | Supported |
| ------- | ------------------ |
| > 1.0 | :white_check_mark: |
| < 1.0 | :x: |

## Reporting a Vulnerability

If you have found a potential security threat, vulnerability or exploit in Tauri
or one of its upstream dependencies, please DON’T create a pull-request, DON’T
file an issue on GitHub, DON’T mention it on Discord and DON’T create a forum thread.

We will be adding contact information to this page very soon.

At the current time we do not have the financial ability to reward bounties,
but in extreme cases will at our discretion consider a reward.
2 changes: 1 addition & 1 deletion build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ fn main() {}

#[cfg(target_os = "macos")]
fn main() {
println!("cargo:rustc-link-lib=framework=WebKit");
println!("cargo:rustc-link-lib=framework=WebKit");
}

#[cfg(target_os = "windows")]
Expand Down
30 changes: 15 additions & 15 deletions examples/dragndrop.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@ Dropping files onto the following form is also possible:<br><br>
"#;

fn main() -> Result<()> {
let mut app = Application::new()?;
let mut app = Application::new()?;

app.add_window_with_configs(
Attributes {
url: Some(TEST_HTML.to_string()),
..Default::default()
},
None,
None,
Some(Box::new(|data| {
println!("Window 1: {:?}", data);
false // Returning true will block the OS default behaviour.
})),
)?;
app.run();
Ok(())
app.add_window_with_configs(
Attributes {
url: Some(TEST_HTML.to_string()),
..Default::default()
},
None,
None,
Some(Box::new(|data| {
println!("Window 1: {:?}", data);
false // Returning true will block the OS default behaviour.
})),
)?;
app.run();
Ok(())
}
25 changes: 12 additions & 13 deletions examples/fullscreen.rs
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
use wry::Result;
use wry::{Application, Attributes};
use wry::{Application, Attributes, Result};

fn main() -> Result<()> {
let mut app = Application::new()?;
let mut app = Application::new()?;

let attributes = Attributes {
url: Some("https://www.wirple.com/".to_string()),
title: String::from("3D Render Test ^ ^"),
fullscreen: true,
transparent: true,
..Default::default()
};
let attributes = Attributes {
url: Some("https://www.wirple.com/".to_string()),
title: String::from("3D Render Test ^ ^"),
fullscreen: true,
transparent: true,
..Default::default()
};

app.add_window(attributes)?;
app.run();
Ok(())
app.add_window(attributes)?;
app.run();
Ok(())
}

// Test Result:
Expand Down
12 changes: 6 additions & 6 deletions examples/gtk.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ use cairo::*;
use gtk::*;

fn main() -> Result<()> {
gtk::init()?;
let window = Window::new(WindowType::Toplevel);
gtk::init()?;
let window = Window::new(WindowType::Toplevel);

window.show_all();
// TODO add to webview
window.show_all();
// TODO add to webview

gtk::main();
Ok(())
gtk::main();
Ok(())
}
18 changes: 9 additions & 9 deletions examples/hello_world.rs
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
use wry::{Application, Attributes, Result};

fn main() -> Result<()> {
let mut app = Application::new()?;
let mut app = Application::new()?;

let attributes = Attributes {
url: Some("https://tauri.studio/".to_string()),
title: String::from("Hello World!"),
..Default::default()
};
let attributes = Attributes {
url: Some("https://tauri.studio/".to_string()),
title: String::from("Hello World!"),
..Default::default()
};

app.add_window(attributes)?;
app.run();
Ok(())
app.add_window(attributes)?;
app.run();
Ok(())
}
Loading

0 comments on commit fae4bbc

Please sign in to comment.