Skip to content

Commit e54dd75

Browse files
authored
Initial changes for the handoff from Embark to the community. (#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
1 parent 54f6978 commit e54dd75

21 files changed

+101
-213
lines changed

.github/CODEOWNERS

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
* @eddyb
2-
3-
/examples/ @fu5ha @VZout
1+
* @eddyb @LegNeato @fornwall

.github/ISSUE_TEMPLATE/enhancement.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,13 @@ labels: "t: enhancement"
66
---
77

88
<!--
9-
Thank you for your interest in the `rust-gpu` project! This template is for
10-
proposing a minor improvement, such as addig a new method, or improving
11-
documentation. Please try to provide a short high level overview of what you would
9+
Thank you for your interest in the `rust-gpu` project!
10+
Please try to provide a short high level overview of what you would
1211
like you to add. Also be sure to check the existing and `wontfix` issues to see
1312
if it's already been proposed before posting.
1413
15-
Existing Issues: https://github.com/EmbarkStudios/rust-gpu/issues?q=is%3Aopen+is%3Aissue+label%3A%22t%3A+enhancement%22
16-
Closed Issues: https://github.com/EmbarkStudios/rust-gpu/labels/s%3A%20wontfix
14+
Existing Issues: https://github.com/rust-gpu/rust-gpu/issues?q=is%3Aopen+is%3Aissue+label%3A%22t%3A+enhancement%22
15+
Closed Issues: https://github.com/rust-gpu/rust-gpu/labels/s%3A%20wontfix
1716
1817
-->
1918

.github/ISSUE_TEMPLATE/mcp.md

-20
This file was deleted.

.github/ISSUE_TEMPLATE/meeting.md

-17
This file was deleted.

.github/workflows/ci.yaml

+4-4
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ jobs:
1717
strategy:
1818
matrix:
1919
include:
20-
- os: ubuntu-20.04-16core
20+
- os: ubuntu-20.04
2121
target: x86_64-unknown-linux-gnu
22-
- os: windows-2022-16core
22+
- os: windows-2022
2323
target: x86_64-pc-windows-msvc
24-
- os: macOS-latest-xl
24+
- os: macOS-latest
2525
target: x86_64-apple-darwin
26-
- os: ubuntu-20.04-16core
26+
- os: ubuntu-20.04
2727
target: aarch64-linux-android
2828
host: x86_64-unknown-linux-gnu
2929
runs-on: ${{ matrix.os }}

CHANGELOG.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
130130
- [PR#998](https://github.com/EmbarkStudios/rust-gpu/pull/998) added `extra_arg()` SpirvBuilder API to be able to set codegen args otherwise not supported by the API (for example, to set `--spirv-passes`)
131131

132132
### Changed 🛠
133-
- [PR#999](https://github.com/EmbarkStudios/rust-gpu/pull/999) made the [`SPIR-🇹` shader IR framework](https://github.com/EmbarkStudios/spirt) the default (you can opt out via `RUSTGPU_CODEGEN_ARGS=--no-spirt`)
133+
- [PR#999](https://github.com/EmbarkStudios/rust-gpu/pull/999) made the [`SPIR-🇹` shader IR framework](https://github.com/rust-gpu/spirt) the default (you can opt out via `RUSTGPU_CODEGEN_ARGS=--no-spirt`)
134134
- [PR#992](https://github.com/EmbarkStudios/rust-gpu/pull/992) renamed `rust-toolchain` to `rust-toolchain.toml`
135135
- [PR#991](https://github.com/EmbarkStudios/rust-gpu/pull/991) updated toolchain to `nightly-2023-01-21`
136136
- [PR#990](https://github.com/EmbarkStudios/rust-gpu/pull/990) removed return type inference from `Image` API and made `glam` usage mandatory
@@ -153,7 +153,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
153153
- `RUSTGPU_RUSTFLAGS="..."` for shader `RUSTFLAGS="..."`
154154
- `RUSTGPU_CODEGEN_ARGS="..."` for shader "codegen args" (i.e. `RUSTFLAGS=-Cllvm-args="..."`)
155155
(check out [the "codegen args" docs](docs/src/codegen-args.md), or run with `RUSTGPU_CODEGEN_ARGS=--help` to see the full list of options)
156-
- [PR#940](https://github.com/EmbarkStudios/rust-gpu/pull/940) integrated the experimental [`SPIR-🇹` shader IR framework](https://github.com/EmbarkStudios/spirt) into the linker
156+
- [PR#940](https://github.com/EmbarkStudios/rust-gpu/pull/940) integrated the experimental [`SPIR-🇹` shader IR framework](https://github.com/rust-gpu/spirt) into the linker
157157
(opt-in via `RUSTGPU_CODEGEN_ARGS=--spirt`, see also [the `--spirt` docs](docs/src/codegen-args.md#--spirt), for more details)
158158

159159
### Changed 🛠️

CODE_OF_CONDUCT.md

+23-24
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ We as members, contributors, and leaders pledge to make participation in our
66
community a harassment-free experience for everyone, regardless of age, body
77
size, visible or invisible disability, ethnicity, sex characteristics, gender
88
identity and expression, level of experience, education, socio-economic status,
9-
nationality, personal appearance, race, religion, or sexual identity
10-
and orientation.
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
1111

1212
We pledge to act and interact in ways that contribute to an open, welcoming,
1313
diverse, inclusive, and healthy community.
@@ -22,17 +22,17 @@ community include:
2222
* Giving and gracefully accepting constructive feedback
2323
* Accepting responsibility and apologizing to those affected by our mistakes,
2424
and learning from the experience
25-
* Focusing on what is best not just for us as individuals, but for the
26-
overall community
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
2727

2828
Examples of unacceptable behavior include:
2929

30-
* The use of sexualized language or imagery, and sexual attention or
31-
advances of any kind
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
3232
* Trolling, insulting or derogatory comments, and personal or political attacks
3333
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email
35-
address, without their explicit permission
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
3636
* Other conduct which could reasonably be considered inappropriate in a
3737
professional setting
3838

@@ -52,15 +52,14 @@ decisions when appropriate.
5252

5353
This Code of Conduct applies within all community spaces, and also applies when
5454
an individual is officially representing the community in public spaces.
55-
Examples of representing our community include using an official e-mail address,
55+
Examples of representing our community include using an official email address,
5656
posting via an official social media account, or acting as an appointed
5757
representative at an online or offline event.
5858

5959
## Enforcement
6060

6161
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement at
63-
62+
reported to the community leaders.
6463
All complaints will be reviewed and investigated promptly and fairly.
6564

6665
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.
8281

8382
### 2. Warning
8483

85-
**Community Impact**: A violation through a single incident or series
86-
of actions.
84+
**Community Impact**: A violation through a single incident or series of
85+
actions.
8786

8887
**Consequence**: A warning with consequences for continued behavior. No
8988
interaction with the people involved, including unsolicited interaction with
9089
those enforcing the Code of Conduct, for a specified period of time. This
9190
includes avoiding interactions in community spaces as well as external channels
92-
like social media. Violating these terms may lead to a temporary or
93-
permanent ban.
91+
like social media. Violating these terms may lead to a temporary or permanent
92+
ban.
9493

9594
### 3. Temporary Ban
9695

@@ -106,27 +105,27 @@ Violating these terms may lead to a permanent ban.
106105
### 4. Permanent Ban
107106

108107
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
108+
standards, including sustained inappropriate behavior, harassment of an
110109
individual, or aggression toward or disparagement of classes of individuals.
111110

112-
**Consequence**: A permanent ban from any sort of public interaction within
113-
the community.
111+
**Consequence**: A permanent ban from any sort of public interaction within the
112+
community.
114113

115114
## Attribution
116115

117116
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118-
version 2.0, available at
119-
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
117+
version 2.1, available at
118+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120119

121-
Community Impact Guidelines were inspired by
120+
Community Impact Guidelines were inspired by
122121
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123122

124123
For answers to common questions about this code of conduct, see the FAQ at
125-
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
126-
at [https://www.contributor-covenant.org/translations][translations].
124+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
125+
[https://www.contributor-covenant.org/translations][translations].
127126

128127
[homepage]: https://www.contributor-covenant.org
129-
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
128+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130129
[Mozilla CoC]: https://github.com/mozilla/diversity
131130
[FAQ]: https://www.contributor-covenant.org/faq
132131
[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

+11-69
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
# Embark Contributor Guidelines
1+
# Contributor Guidelines
22

3-
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.
3+
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.
44

5-
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.
5+
## How to get help
66

7-
If you have ideas for collaboration, email us at [email protected].
7+
For questions, clarifications, and general help please first search [Github
8+
discussions](discussions) and then ask your question if you can't find the answer.
89

9-
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).
10+
[discussions]: https://github.com/rust-gpu/rust-gpu/discussions
1011

1112
## Issues
1213

@@ -20,21 +21,10 @@ Feature requests will be tagged as `enhancement` and their status will be update
2021

2122
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.
2223

23-
Reproducible bugs will be tagged as `bug` and their status will be updated in the comments of the issue.
24-
2524
### Wontfix
2625

2726
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.
2827

29-
### Labels
30-
The labels for this repository are divided into the following categories;
31-
32-
- **`c:` Crate** Issues specific a single crate in the repository.
33-
- **`g:` GPU** Issues specific a GPU vendor.
34-
- **`p:` Platform** Issues specific a single operating system or platform.
35-
- **`s:` Status** The current status of a PR or issue.
36-
- **`t:` Type** The general type of the issue. (E.g. `t: bug` for bugs.)
37-
3828
## Contribution Workflow
3929

4030
### Open Issues
@@ -43,51 +33,7 @@ If you're ready to contribute, start by looking at our open issues tagged as [`h
4333

4434
You can comment on the issue to let others know you're interested in working on it or to ask questions.
4535

46-
### Major Change Process
47-
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].
48-
49-
[dis]: https://discord.gg/8TW9nfF
50-
[open-issue]: https://github.com/EmbarkStudios/rust-gpu/issues/new
51-
52-
#### Definitions
53-
54-
##### **Major Change Proposal (MCP)**
55-
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.
56-
57-
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.
58-
59-
[mcp-template]: https://github.com/rust-lang/rust/issues/new?labels=mcp%3A%20proposed&template=mcp.md
60-
61-
Examples of what would require an MCP:
62-
63-
- Changing the compiler architecture.
64-
- Adding support for an existing Rust language or feature.
65-
- Small additions (e.g. new methods) to `spirv-std` types.
66-
- Proposing an RFC.
67-
68-
Examples of what would **not** require an MCP:
69-
70-
- Updating documentation
71-
- Fixing existing bugs
72-
- Performance improvements
73-
74-
##### **Request For Comments (RFC)**
75-
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.
76-
77-
[rfc-template]: https://github.com/EmbarkStudios/rust-gpu/blob/main/rfcs/000-template.md
78-
79-
Examples of what would require an RFC:
80-
81-
- Major additions to `spirv-std`, such as new APIs, or breaking changes to existing ones.
82-
83-
#### Life-cycle
84-
85-
1. You file a [major change proposal][mcp-template] outlining the changes and the motivation for it.
86-
2. A member of the team will review the proposal and tag it with the appropriate label.
87-
2.1. `mcp: accepted` means that the MCP has been accepted and is ready for a pull request implementing it.
88-
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.
89-
2.3 Closing an issue means that the MCP has rejected.
90-
3. If the proposal has been accepted then the implementation can begin.
36+
[open-issue]: https://github.com/rust-gpu/rust-gpu/issues/new
9137

9238
### Pull Request Process
9339

@@ -97,16 +43,12 @@ Examples of what would require an RFC:
9743
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).
9844
5. A maintainer will review your pull request and may ask you to make changes.
9945

100-
## Code Guidelines
101-
102-
### Rust
103-
104-
You can read about our standards and recommendations for working with Rust [here](https://github.com/EmbarkStudios/rust-ecosystem/blob/master/guidelines.md).
105-
10646
## Licensing
10747

108-
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.
48+
This project is licensed under a dual MIT OR Apache-2.0 license, allowing licensees to chose either at their option.
10949

11050
## Code of Conduct
11151

112-
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.
52+
Please note that our project has a [Contributor Code of Conduct](CODE_OF_CONDUCT.md) to
53+
ensure it is a welcoming place for everyone to contribute. By participating in this
54+
project, you agree to abide by these terms.

Cargo.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ members = [
2525

2626
[workspace.package]
2727
version = "0.9.0"
28-
authors = ["Embark <[email protected]>"]
28+
authors = ["rust-gpu developers", "Embark <[email protected]>"]
2929
edition = "2021"
3030
license = "MIT OR Apache-2.0"
31-
repository = "https://github.com/EmbarkStudios/rust-gpu"
31+
repository = "https://github.com/rust-gpu/rust-gpu"
3232

3333
[workspace.dependencies]
3434
spirv-builder = { path = "./crates/spirv-builder", version = "=0.9.0", default-features = false }

LICENSE-MIT

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
Copyright (c) 2019 Embark Studios
2-
31
Permission is hereby granted, free of charge, to any
42
person obtaining a copy of this software and associated
53
documentation files (the "Software"), to deal in the

0 commit comments

Comments
 (0)