Skip to content

Commit 74bbf15

Browse files
committed
Updated Readme#Contributing
1 parent d80590e commit 74bbf15

File tree

1 file changed

+55
-5
lines changed

1 file changed

+55
-5
lines changed

README.md

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -180,11 +180,61 @@ Use the example in `examples/winit_wgpu_min.rs` as a starting point.
180180

181181
[![PRs Welcome](https://img.shields.io/badge/PullRequest-welcome-brightgreen.svg?style=flat-square)]()
182182

183-
* Start with the roadmap RFC: [EFX-0001](efx/docs/rfcs/EFX-0001-roadmap-0.5-0.7.md).
184-
* You can write me with your ideas on [[email protected]](mailto:[email protected]).
185-
* Open issues are grouped by milestones **0.6 / 0.7 / 0.8**.
186-
* PRs that change behavior should reference the relevant RFC section.
187-
* Looking for help with: Bevy example(s), raw `winit+wgpu` example, attribute codegen & compile-fail tests, docs.
183+
**Thanks for considering a contribution!** Please follow this lightweight workflow:
184+
185+
#### 1) Pick or propose an issue
186+
187+
* **Claim an issue:** comment “I’d like to take this” (optionally add a brief plan/ETA).
188+
The maintainer will assign it to you.
189+
* **Propose a new issue:** open a ticket with a minimal reproducible example (for bugs) or a short rationale (for features).
190+
Start with the roadmap RFC: [EFX-0001](efx/docs/rfcs/EFX-0001-roadmap-0.5-0.7.md).
191+
192+
> Tip: issues labeled `good first issue` are designed for first-time contributors.
193+
194+
#### 2) Fork & branch
195+
196+
* Fork the repository and create a **feature branch from `main`**:
197+
198+
```bash
199+
git checkout main
200+
git pull
201+
git checkout -b feat/short-topic
202+
```
203+
* Keep your branch focused on **one issue**.
204+
205+
#### 3) Implement with tests & docs
206+
207+
* Make the change and add tests/docs where it makes sense.
208+
* Local checks (examples build-only; no GUI run is required):
209+
210+
```bash
211+
cargo fmt --all
212+
cargo clippy --all-targets -- -D warnings
213+
cargo build --workspace --locked
214+
cargo build -p efx --example eframe_demo --locked
215+
rustup target add wasm32-unknown-unknown
216+
cargo build -p efx --example eframe_demo --target wasm32-unknown-unknown --locked
217+
```
218+
219+
#### 4) Open a Pull Request
220+
221+
* Target the **next release branch** (e.g., `v0.6`, `v0.7`).
222+
If the issue has a **milestone**, use the branch named after that milestone.
223+
* Link the issue (e.g., “Closes #123”) and fill the checklist below.
224+
225+
**PR checklist**
226+
227+
* [ ] References the related issue / RFC section when behavior changes.
228+
* [ ] CI is green (workspace build, examples, wasm32 build-only).
229+
* [ ] Tests/docs updated where applicable.
230+
* [ ] No unrelated changes.
231+
232+
#### 5) Reviews & merge
233+
234+
* Address review comments; small, focused PRs get merged faster.
235+
* If you go silent for **7 days**, the issue may be unassigned to keep momentum (you can re-claim it anytime).
236+
237+
**Questions?** Reach out at [[email protected]](mailto:[email protected]).
188238

189239
---
190240

0 commit comments

Comments
 (0)