From a341aa79f09288fb310c3bd57bdebdb0e115de00 Mon Sep 17 00:00:00 2001 From: "Dr. Rubisco" <76263371+thedocruby@users.noreply.github.com> Date: Fri, 3 Nov 2023 16:56:50 -0400 Subject: [PATCH] Structure tweaks --- .vscode/extensions.json | 11 +++ CODE_OF_CONDUCT.md | 132 +++++++++++++++++++++++++ Cargo.lock | 4 +- Cargo.toml | 4 +- build.rs | 4 +- examples/{example.rs => standalone.rs} | 0 gravylib_helpers/Cargo.toml | 2 +- gravylib_macros/Cargo.toml | 2 +- 8 files changed, 152 insertions(+), 7 deletions(-) create mode 100644 .vscode/extensions.json create mode 100644 CODE_OF_CONDUCT.md rename examples/{example.rs => standalone.rs} (100%) diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..594ffe9 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,11 @@ +{ + "recommendations": [ + "Swellaby.rust-pack", + "JScearcy.rust-doc-viewer", + "Tion.evenbettercomments", + "bierner.github-markdown-preview", + "ozaki.markdown-github-dark", + "me-dutour-mathieu.vscode-github-actions", + "GitHub.github-vscode-theme", + ] +} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..17092f6 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders 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, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement on the [Official Gravy Discord Server](https://discord.gg/7cBw5KHe6q). +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available +at [https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/Cargo.lock b/Cargo.lock index 52bf788..5112765 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -811,7 +811,7 @@ dependencies = [ [[package]] name = "gravylib_helpers" -version = "0.0.0" +version = "0.1.0-alpha" dependencies = [ "bytemuck", "spirv-std", @@ -819,7 +819,7 @@ dependencies = [ [[package]] name = "gravylib_macros" -version = "0.0.0" +version = "0.1.0-alpha" dependencies = [ "proc-macro2", "quote", diff --git a/Cargo.toml b/Cargo.toml index 93aa792..3d601c5 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -4,7 +4,7 @@ version = "0.1.0-alpha" edition = "2021" license = "MIT OR Apache-2.0" authors = ["Dr. Rubisco "] -description = "(WIP) Making GPU-first development a reality, with the power of GPU Rust." +description = "Making GPU-first development a reality, with the power of GPU Rust." keywords = [ "rust-gpu", "wgpu", @@ -49,7 +49,7 @@ resolver = "2" members = ["examples/shaders", "gravylib_helpers", "gravylib_macros"] [[example]] -name = "example" +name = "standalone" # See rustc_codegen_spirv/Cargo.toml for details on these features [features] diff --git a/build.rs b/build.rs index dfb0f9e..aaea9d7 100644 --- a/build.rs +++ b/build.rs @@ -9,7 +9,9 @@ fn main() -> Result<(), Box> { .build()?; // External shaders, should be built alongside the dependent crate - // Currently not, since we are using `src/bin/runner.rs` as an internal testbed + // Built alongside `gravylib` because it's needed for the tests/examples + // TODO: Look into a way to build this only when needed (i.e when running tests/examples) + // TODO: This is kinda boilerplate... Can we abstract this for devs with `gravylib_macros`? SpirvBuilder::new("examples/shaders", "spirv-unknown-vulkan1.1") .print_metadata(MetadataPrintout::Full) .build()?; diff --git a/examples/example.rs b/examples/standalone.rs similarity index 100% rename from examples/example.rs rename to examples/standalone.rs diff --git a/gravylib_helpers/Cargo.toml b/gravylib_helpers/Cargo.toml index ed129fc..b26a7ce 100644 --- a/gravylib_helpers/Cargo.toml +++ b/gravylib_helpers/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "gravylib_helpers" -version = "0.0.0" +version = "0.1.0-alpha" publish = false authors.workspace = true edition.workspace = true diff --git a/gravylib_macros/Cargo.toml b/gravylib_macros/Cargo.toml index 6a4afcb..d163a1c 100644 --- a/gravylib_macros/Cargo.toml +++ b/gravylib_macros/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "gravylib_macros" -version = "0.0.0" +version = "0.1.0-alpha" publish = false authors.workspace = true edition.workspace = true