Log in to edit or delete your comments and be notified of replies.

Sign up Already have an account? Log in

2021/05/25 04:36:05

# Tr

No (Edited)

2021/05/25 04:36:44

This feels like it could be subsumed by Code Quality (Edited)

2021/05/25 04:57:14

Hm, yes that is true. However I more so view Code Quality as refactoring code to make it more ergonomic, and code removal is for just removing unnecessary code.

2021/05/25 04:57:45

I'm just a big fan of PRs that remove unnecessary code that I think it deserves its own label haha... :D

2021/05/25 04:38:17

- Th

Ideally this process is completely automatic. (Edited)

2021/05/25 05:08:30

Yep, I'm not quite sure how to automate this yet, but it should be simple.

2021/05/25 05:09:02

Though arguably, if we have to manually add the appropriate labels, then simply moving the story to a different column is trivial in that work flow?

2021/05/25 21:30:55

It'll be annoying on mobile, and will force another window to be open I think. I'd really like to automate this.

2021/05/25 04:42:03

to move from the `Review

IMO this distinction isn't important: we occasionally get high-quality approvals from non-org members and I haven't seen any issues with false positives. (Edited)

2021/05/25 05:04:47

Lol, for some reason I thought you could only approve a PR if you were an org member... I'm dumb...

2021/05/25 04:42:21

the PR will be officially reviewed by **Cart**

This is a bit too timely :p (Edited)

2021/05/25 05:05:54

:( <3

2021/05/25 04:43:36

This should be automated via cart by reviewing and click the `request changes` button on the review.

IMO we should have a bot command for this, and enable it (and the reverse command) for org members. (Edited)

2021/05/25 05:16:07

Ohh, a bot command would be great for this.

2021/05/25 04:59:51

Yeah but I don't think there's much of a use to filter for one but not the other :p (Edited)

2021/05/25 05:19:41

# Triage :clipboard: - Triaging is c

This is needed on Issues too :) (Edited)

2021/05/25 18:54:33

ocs

I'm not convinced that emoji are worth the added cost of (1) extra space and (2) additional weirdness for when interacting with labels as text (ex: typing the label in a filter, labels in urls, etc) (Edited)

2021/05/25 19:27:49

I mean, if you're manually typing in the labels then yes it can be a pain since you have to do: label"Bug :bug:". How its super simple on github. You just click the `issues` drop down and choose the ones you want

2021/05/25 19:36:42

Ahh, though I guess I can see how it can be difficult with urls... That's a fair sentiment.

2021/05/25 18:56:55

## PR Template :p

Imo this just adds more "process" to the system. We already have labels to filter for these things. And it adds a new category of work for the triage team to add "title emoji" when the user doesn't add them / uses the wrong one. (Edited)

2021/05/25 19:24:22

Yea, some other people have expressed this as well. I'm partial to it since I've used it extensively at my past two companies and found it quite useful. However, it seems the consensus is to remove these which just makes me a little sad :') But I do agree that duplicating the labels in the PR title may not be the best approach.

2021/05/25 19:03:52

```mermaid graph TD D(In Progress) --> |Request Changes| E(Review in Progress); E --> |2+ Approve| F(Reviewer Approved); F --> |Request Changes| E; F --> |Merged/Closed| G(Done); ```

Adjusting the state every time someone requests a change is a lot to ask (it also introduces noise to the pr as the tag is added/removed multiple times). This could happen many times over the course of a PR. (Edited)

2021/05/25 19:19:53

The `Review in Progress` and `Reviewer Approved` are columns of the story board (not tags).

2021/05/25 19:20:54

This process can be fully automated by github. E.g., when 2+ people approve a PR, it automatically moves to the next column. When someone else requests changes, it move back.

2021/05/25 19:05:57

the `Done` column

We use bors to merge prs, which puts them in the Closed state instead of the Merged state. (Edited)

2021/05/25 21:30:07

### Status Label Descriptions - **ready-for-final-review**: this PR is ready for @cart to officially review. - **abandoned**: this PR was abandoned with seemingly no

I would prefer to tag all, but the strategy should be the same as what we use for difficulty. (Edited)

2021/05/25 21:31:44

@cart I'm curious what your thoughts are here

2021/05/25 21:31:56

the `Done` column

This should be fine, provided we can get the automation to play nice. (Edited)

2021/05/25 21:33:49

Add e

I'm not convinced that the value added here is high enough to be worth it over just looking at the labels. If we cut emoji, I would prefer to have "[Docs] Add example for using commands" for our standard format as that's the critical label for looking at change-logs (Edited)

2021/05/25 22:04:02

Again, the problem with labels is that one the PR gets merged, we lose all label context. And all we're left with is the PR title/commit description (Edited)

2021/05/26 19:10:56

ocs

Yea, it's probably best to just remove them from the label. (Edited)

The Bevy Development Process

Image Not Showing Possible Reasons
The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported
Learn More →

Github Repository

Table of Contents

Image Not Showing Possible Reasons
The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported
Learn More →

The Bevy Development Process
Table of Contents
Story Board
- Lifecycles
  - PR Lifecycle
  - Issue Lifecycle
Github Labels
Triage
- Example Triaged PR
- Example Triaged Issue
Pull Requests
- PR Template
- Example PR
- Problem:
- Solution:
- Reviews

Story Board

Image Not Showing Possible Reasons
The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported
Learn More →

| Backlog | In Progress | Review In Progress | Reviewer Approved | Done |
| - | - | - | - | - | - |
| Issues | Issues/PRs | PRs | PRs | Issues/PRs | Issues/PRs

Each of the columns represents the current state of a given story.
Stories will live in in a single column at a given time, moving from one to the other once appropriate progress had been made.

Lifecycles

Image Not Showing Possible Reasons
The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported
Learn More →

PR Lifecycle

Issue Lifecycle

Github Labels

Image Not Showing Possible Reasons
The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported
Learn More →

Each of the following label columns represent a different category.
There is a single color associated with each category.
Each issue/PR is required to have the below labels (except where opt is specified).

The layout of labels will be as follows:
<prefix>: <label>
e.g.
T: enhancement

Categories and Colors

Image Not Showing Possible Reasons
The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported
Learn More →

<Category> <Color>
Content

Image Not Showing Possible Reasons

The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported

Type

Image Not Showing Possible Reasons

The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported

Priority

Image Not Showing Possible Reasons

The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported

Difficulty

Image Not Showing Possible Reasons

The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported

Status

Image Not Showing Possible Reasons

The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported

Platform

Image Not Showing Possible Reasons

The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported

Generic Labels

For both Issues and PRs

Type [T] (one or more)	Category [C]	Platform [X] (opt)	Priority [P] (opt)
enhancement	window	Windows	critical
bug	ci/build-system	Linux	high
code-quality	animation	Mac
accessability	assets	iOS
docs	audio	Android
hotifx	ecs	XR
performance	editor	Web
breaking change	physics
code-cleanup	scenes
crash	rendering
testing	tasks
dependencies	ecosystem
regression	ui
duplicate	input
examples	math
	reflection
	transform
	app
	ai
	modding

PR Labels

Image Not Showing Possible Reasons
The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported
Learn More →

Status [S] (optional)
needs triage
ready for final review
abandoned

Issue Labels

Image Not Showing Possible Reasons
The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported
Learn More →

Difficulty [D] (opt)	Status [S]
good first issue	needs triage
complex	needs investigation
	needs design
	ready for implementation
	blocked upstream
	invalid
	wontfix
	needs-rfc
	help-wanted
	user-error

Status Label Descriptions

ready-for-final-review: this PR is ready for @cart to officially review.
abandoned: this PR was abandoned with seemingly no intent to continue progress
needs-triage: this issue needs labels
needs-investigation: this issue must be examined/reproduced
needs-design: needs design work laying out how it might be implemented
ready-for-implementation: needs to be implemented in a concerete form
blocked-upstream: no progress can be made until an upstream depdedency changes/fixes something
invalid: This is spam, a duplicate issue, or user error
wontfix: this direction won't be taken in favor of another approach
needs-rfc: this proposes a large change that is not sufficently covered in an issue. An RFC should be created for more in-depth discussions.

Triage

Image Not Showing Possible Reasons
The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported
Learn More →

Triaging is conducted via Github Labels.
Each story has a set of associated labels.
Issues and PRs have a different set of associated labels
Triaging is complete when the appropriate labels have been assigned and the Needs Traige label is removed.
The triage team will add the appropriate labels to issues/PRs.

Example Triaged PR

PR: Fixing an important rendering bug for Windows
Labels:
- T-Bug
- C-Rendering
- X-Windows
- P-High

Example Triaged Issue

Issue: Entities do not implement std::fmt::Debug.
Labels:
- T-Enhancement
- C-ECS
- D-good-first-issue
- S-ready-for-implementation

Pull Requests

Image Not Showing Possible Reasons
The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported
Learn More →

PR Template

Image Not Showing Possible Reasons
The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported
Learn More →

This should be added into the main repository via .github/.pull_request_template.md

Brief Description

## Problem:
- Describe the problem this PR solves here. 
- If you're fixing an issue, say "Fixes #X".

## Solution:
- Describe the solution used to overcome the problem.

## Additional Information:
- Any additional information needed to better understand this PR.

Why?
- There is currenlty no standard for the PR messages that get merged into main.
- This template encourage descriptive PRs that thoroughly explains what it accomplishes.

Example PR

Add example for using Commands

Problem:

There are insufficient examples showing how to use Commands

Solution:

Add additional examples making is clear how to correctly use Commands in various contexts.

Reviews

Image Not Showing Possible Reasons
The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported
Learn More →

Pull requests can be reviewed by anyone who contributes to bevy!
A pull request requires at least two approvals to move from the Review in Progress to the Reviewer Approved story board columns. At this point, a triage member should mark the PR as ready-for-final-review and once in the Reviewer Approved column, the PR will be officially reviewed by Cart, and either

Merge: at which point the PR moves to the Done column.
Request Changes: which then moves the story back to the Review in Progress column.
- This should be automated via cart by reviewing and click the request changes button on the review.