You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CHANGELOG.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -130,7 +130,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
130
130
-[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`)
131
131
132
132
### 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`)
134
134
-[PR#992](https://github.com/EmbarkStudios/rust-gpu/pull/992) renamed `rust-toolchain` to `rust-toolchain.toml`
135
135
-[PR#991](https://github.com/EmbarkStudios/rust-gpu/pull/991) updated toolchain to `nightly-2023-01-21`
136
136
-[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
153
153
-`RUSTGPU_RUSTFLAGS="..."` for shader `RUSTFLAGS="..."`
154
154
-`RUSTGPU_CODEGEN_ARGS="..."` for shader "codegen args" (i.e. `RUSTFLAGS=-Cllvm-args="..."`)
155
155
(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
157
157
(opt-in via `RUSTGPU_CODEGEN_ARGS=--spirt`, see also [the `--spirt` docs](docs/src/codegen-args.md#--spirt), for more details)
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.
4
4
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.
@@ -20,21 +21,10 @@ Feature requests will be tagged as `enhancement` and their status will be update
20
21
21
22
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.
22
23
23
-
Reproducible bugs will be tagged as `bug` and their status will be updated in the comments of the issue.
24
-
25
24
### Wontfix
26
25
27
26
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.
28
27
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
-
38
28
## Contribution Workflow
39
29
40
30
### Open Issues
@@ -43,51 +33,7 @@ If you're ready to contribute, start by looking at our open issues tagged as [`h
43
33
44
34
You can comment on the issue to let others know you're interested in working on it or to ask questions.
45
35
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].
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.
- 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.
@@ -97,16 +43,12 @@ Examples of what would require an RFC:
97
43
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).
98
44
5. A maintainer will review your pull request and may ask you to make changes.
99
45
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
-
106
46
## Licensing
107
47
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.
109
49
110
50
## Code of Conduct
111
51
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
0 commit comments