Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contributing.md #2515

Merged
merged 6 commits into from
Apr 22, 2021
Merged

Update contributing.md #2515

merged 6 commits into from
Apr 22, 2021

Conversation

marcaaron
Copy link
Contributor

Details

Just adding something about what makes a good problem to CONTRIBUTING.md to give people insights into how to propose good issues and avoid frustration.

Fixed Issues

No Issue

Tests

QA Steps

Tested On

Screenshots

N/A

@marcaaron marcaaron self-assigned this Apr 21, 2021
@marcaaron marcaaron requested a review from a team as a code owner April 21, 2021 17:32
@MelvinBot MelvinBot requested review from Beamanator and removed request for a team April 21, 2021 17:32
Jag96
Jag96 previously approved these changes Apr 21, 2021
Copy link
Contributor

@Jag96 Jag96 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of potential improvements, but looks good

CONTRIBUTING.md Outdated
6. Pause on this step until a member of the Expensify team responds on your issue with next steps.

#### Solving Problems

Our problem solving approach at Expensify is to focus on high value problems and avoid small optimizations with difficult to measure results. We also prefer to identify and solve problems at their root. Given that, please ensure all proposals fix a specific problem in a measurable way with evidence so they are easy to evaluate. Here's an example:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nab - small optimizations with results that are difficult to measure reads a bit easier imo

CONTRIBUTING.md Outdated
6. Pause on this step until a member of the Expensify team responds on your issue with next steps.

#### Solving Problems

Our problem solving approach at Expensify is to focus on high value problems and avoid small optimizations with difficult to measure results. We also prefer to identify and solve problems at their root. Given that, please ensure all proposals fix a specific problem in a measurable way with evidence so they are easy to evaluate. Here's an example:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd also clarify Here's an example of a good problem/solution here instead of Here's an example so it's more clear

Jag96
Jag96 previously approved these changes Apr 21, 2021
tgolen
tgolen previously approved these changes Apr 21, 2021
Copy link
Contributor

@tgolen tgolen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love this addition.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated
6. Pause on this step until a member of the Expensify team responds on your issue with next steps.

#### Solving Problems

Our problem solving approach at Expensify is to focus on high value problems and avoid small optimizations with results that are difficult to measure. We also prefer to identify and solve problems at their root. Given that, please ensure all proposals fix a specific problem in a measurable way with evidence so they are easy to evaluate. Here's an example of a good problem/solution:
Copy link
Contributor

@Beamanator Beamanator Apr 21, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAB;

I kinda feel like "Solving Problems" is not the best title for this section. To me, that title suggests the section would explain "how to solve a problem well."

Since this section is mainly focused on "how Expensify & contributors can submit the most useful proposal", I feel it would be better to title this section "Proposing solutions to problems" or "How to write a great proposal"

Thoughts?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion. To be honest, I think that neither "Proposing solutions to problems" or "How to write a great proposal" encapsulate what I'm trying to communicate here. Making a good proposal to a problem is already defined in the sections below. And people should read this point after they read the "Proposing a job that Expensify hasn’t posted" section.

It's really the lack of defining the problem that people seem to struggle with before they get to know us which is directly tied to the previous section - so maybe this blurb is more of a "note" and should be contained inside the previous section.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ooh I like this - it's not a new section, it's adding additional comments and providing a useful example :)

@marcaaron marcaaron dismissed stale reviews from tgolen and Jag96 via 47757d0 April 21, 2021 21:46
@Beamanator Beamanator self-requested a review April 21, 2021 22:15
Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice updates 👍 LGTM!

@Jag96 Jag96 merged commit b2b02e5 into main Apr 22, 2021
@Jag96 Jag96 deleted the marcaaron-solvingProblems branch April 22, 2021 16:34
@OSBotify
Copy link
Contributor

OSBotify commented May 8, 2021

🚀 Deployed to production in version: 1.0.39-5🚀

platform result
🤖 android 🤖 failure ❌
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants