forked from EmbarkStudios/rust-gpu
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial changes for the handoff from Embark to the community. (Embark…
…Studios#1) * Change URLs * Switch away from paid runners. * Drop copyright from MIT license. Similar to the Rust project. See the git history of https://github.com/rust-lang/rust/blob/master/LICENSE-MIT
- Loading branch information
Showing
21 changed files
with
101 additions
and
213 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1 @@ | ||
| * @eddyb | ||
|
|
||
| /examples/ @fu5ha @VZout | ||
| * @eddyb @LegNeato @fornwall |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,8 +6,8 @@ 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. | ||
| nationality, personal appearance, race, caste, color, 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. | ||
|
|
@@ -22,17 +22,17 @@ community include: | |
| * 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 | ||
| * 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 | ||
| * 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 | ||
| * 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 | ||
|
|
||
|
|
@@ -52,15 +52,14 @@ decisions when appropriate. | |
|
|
||
| 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, | ||
| Examples of representing our community include using an official email 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 at | ||
| [email protected]. | ||
| reported to the community leaders. | ||
| All complaints will be reviewed and investigated promptly and fairly. | ||
|
|
||
| All community leaders are obligated to respect the privacy and security of the | ||
|
|
@@ -82,15 +81,15 @@ behavior was inappropriate. A public apology may be requested. | |
|
|
||
| ### 2. Warning | ||
|
|
||
| **Community Impact**: A violation through a single incident or series | ||
| of actions. | ||
| **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. | ||
| like social media. Violating these terms may lead to a temporary or permanent | ||
| ban. | ||
|
|
||
| ### 3. Temporary Ban | ||
|
|
||
|
|
@@ -106,27 +105,27 @@ 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 | ||
| 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. | ||
| **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]. | ||
| version 2.1, available at | ||
| [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. | ||
|
|
||
| Community Impact Guidelines were inspired by | ||
| 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]. | ||
| [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 | ||
| [v2.1]: https://www.contributor-covenant.org/version/2/1/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 | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,13 @@ | ||
| # Embark Contributor Guidelines | ||
| # Contributor Guidelines | ||
|
|
||
| Welcome! This project is created by the team at [Embark Studios](https://embark.games). We're glad you're interested in contributing! We welcome contributions from people of all backgrounds who are interested in making great software with us. | ||
| Welcome! We're glad you're interested in contributing! We welcome contributions from people of all backgrounds who are interested in making great software with us. | ||
|
|
||
| At Embark, we aspire to empower everyone to create interactive experiences. To do this, we're exploring and pushing the boundaries of new technologies, and sharing our learnings with the open source community. | ||
| ## How to get help | ||
|
|
||
| If you have ideas for collaboration, email us at [email protected]. | ||
| For questions, clarifications, and general help please first search [Github | ||
| discussions](discussions) and then ask your question if you can't find the answer. | ||
|
|
||
| We're also hiring full-time engineers to work with us in Stockholm! Check out our current job postings [here](https://www.embark-studios.com/jobs). | ||
| [discussions]: https://github.com/rust-gpu/rust-gpu/discussions | ||
|
|
||
| ## Issues | ||
|
|
||
|
|
@@ -20,21 +21,10 @@ Feature requests will be tagged as `enhancement` and their status will be update | |
|
|
||
| When reporting a bug or unexpected behaviour in a project, make sure your issue describes steps to reproduce the behaviour, including the platform you were using, what steps you took, and any error messages. | ||
|
|
||
| Reproducible bugs will be tagged as `bug` and their status will be updated in the comments of the issue. | ||
|
|
||
| ### Wontfix | ||
|
|
||
| Issues will be closed and tagged as `wontfix` if we decide that we do not wish to implement it, usually due to being misaligned with the project vision or out of scope. We will comment on the issue with more detailed reasoning. | ||
|
|
||
| ### Labels | ||
| The labels for this repository are divided into the following categories; | ||
|
|
||
| - **`c:` Crate** Issues specific a single crate in the repository. | ||
| - **`g:` GPU** Issues specific a GPU vendor. | ||
| - **`p:` Platform** Issues specific a single operating system or platform. | ||
| - **`s:` Status** The current status of a PR or issue. | ||
| - **`t:` Type** The general type of the issue. (E.g. `t: bug` for bugs.) | ||
|
|
||
| ## Contribution Workflow | ||
|
|
||
| ### Open Issues | ||
|
|
@@ -43,51 +33,7 @@ If you're ready to contribute, start by looking at our open issues tagged as [`h | |
|
|
||
| You can comment on the issue to let others know you're interested in working on it or to ask questions. | ||
|
|
||
| ### Major Change Process | ||
| Most bug fixes can be implemented directly by opening a PR, however for larger design decisions and major changes to the compiler's architecture, this repository uses a two stage "Major Change Proposal" and "Request For Comments" process. If you're unsure about what's required for a specific change you should always start with [**opening an issue**][open-issue] or asking the team over on the `#rust-gpu` channel in the [Embark Discord][dis]. | ||
|
|
||
| [dis]: https://discord.gg/8TW9nfF | ||
| [open-issue]: https://github.com/EmbarkStudios/rust-gpu/issues/new | ||
|
|
||
| #### Definitions | ||
|
|
||
| ##### **Major Change Proposal (MCP)** | ||
| A proposal to make a significant internal changes or small public facing changes to the compiler. An MCP is opened as an issue on `rust-gpu` the repository. An MCP typically only requires one member's approval. Though if the change is significantly big enough it may require the full team's sign off or require an RFC. | ||
|
|
||
| An MCP should generally be a short (1-2 paragraphs) high level overview of the change you would want to make, the motivation behind the change, and potential solutions. There is a [major change issue template][mcp-template] you can use for convenience. | ||
|
|
||
| [mcp-template]: https://github.com/rust-lang/rust/issues/new?labels=mcp%3A%20proposed&template=mcp.md | ||
|
|
||
| Examples of what would require an MCP: | ||
|
|
||
| - Changing the compiler architecture. | ||
| - Adding support for an existing Rust language or feature. | ||
| - Small additions (e.g. new methods) to `spirv-std` types. | ||
| - Proposing an RFC. | ||
|
|
||
| Examples of what would **not** require an MCP: | ||
|
|
||
| - Updating documentation | ||
| - Fixing existing bugs | ||
| - Performance improvements | ||
|
|
||
| ##### **Request For Comments (RFC)** | ||
| A proposal to make significant public facing changes to the compiler or standard library. RFCs are opened as pull requests to the `rust-gpu` repository. RFCs require full sign off by the team, before being approved or implemented. Check out the [RFC `000-template.md` document][rfc-template] for details on the structure. | ||
|
|
||
| [rfc-template]: https://github.com/EmbarkStudios/rust-gpu/blob/main/rfcs/000-template.md | ||
|
|
||
| Examples of what would require an RFC: | ||
|
|
||
| - Major additions to `spirv-std`, such as new APIs, or breaking changes to existing ones. | ||
|
|
||
| #### Life-cycle | ||
|
|
||
| 1. You file a [major change proposal][mcp-template] outlining the changes and the motivation for it. | ||
| 2. A member of the team will review the proposal and tag it with the appropriate label. | ||
| 2.1. `mcp: accepted` means that the MCP has been accepted and is ready for a pull request implementing it. | ||
| 2.2. `mcp: rfc needed` means that the MCP has been accepted as something the team would like but needs a full RFC before the implementation. | ||
| 2.3 Closing an issue means that the MCP has rejected. | ||
| 3. If the proposal has been accepted then the implementation can begin. | ||
| [open-issue]: https://github.com/rust-gpu/rust-gpu/issues/new | ||
|
|
||
| ### Pull Request Process | ||
|
|
||
|
|
@@ -97,16 +43,12 @@ Examples of what would require an RFC: | |
| 4. Open a pull request with a name and description of what you did. You can read more about working with pull requests on GitHub [here](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork). | ||
| 5. A maintainer will review your pull request and may ask you to make changes. | ||
|
|
||
| ## Code Guidelines | ||
|
|
||
| ### Rust | ||
|
|
||
| You can read about our standards and recommendations for working with Rust [here](https://github.com/EmbarkStudios/rust-ecosystem/blob/master/guidelines.md). | ||
|
|
||
| ## Licensing | ||
|
|
||
| Unless otherwise specified, all Embark open source projects are licensed under a dual MIT OR Apache-2.0 license, allowing licensees to chose either at their option. You can read more in each project's respective README. | ||
| This project is licensed under a dual MIT OR Apache-2.0 license, allowing licensees to chose either at their option. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| Please note that our projects are released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md) to ensure that they are welcoming places for everyone to contribute. By participating in any Embark open source project, you agree to abide by these terms. | ||
| Please note that our project has a [Contributor Code of Conduct](CODE_OF_CONDUCT.md) to | ||
| ensure it is a welcoming place for everyone to contribute. By participating in this | ||
| project, you agree to abide by these terms. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,10 +25,10 @@ members = [ | |
|
|
||
| [workspace.package] | ||
| version = "0.9.0" | ||
| authors = ["Embark <[email protected]>"] | ||
| authors = ["rust-gpu developers", "Embark <[email protected]>"] | ||
| edition = "2021" | ||
| license = "MIT OR Apache-2.0" | ||
| repository = "https://github.com/EmbarkStudios/rust-gpu" | ||
| repository = "https://github.com/rust-gpu/rust-gpu" | ||
|
|
||
| [workspace.dependencies] | ||
| spirv-builder = { path = "./crates/spirv-builder", version = "=0.9.0", default-features = false } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.