[No QA] Add proposal template for contributors #14817

marcaaron · 2023-02-03T17:23:41Z

Details

This implements a new proposal template that all contributors should use.
There are also embedded details for C+ to explain what is expected of them when reviewing a proposal. I'm leaving those public. Reasoning: If regular contributors can see that then they'll also already know what C+ is looking out for so hopefully this will lead to less moderation and excessive discussion overall.

Fixed Issues

https://expensify.slack.com/archives/CC7NECV4L/p1675192167083009

Tests

N/A

Offline tests

N/A

QA Steps

N/A

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-02-03T17:41:16Z

@tgolen Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

tgolen

I love the idea of this!

contributingGuides/PROPOSAL_TEMPLATE.md

tgolen · 2023-02-06T14:23:55Z

contributingGuides/PROPOSAL_TEMPLATE.md

+- Excessively wordy explanations.
+
+3. Choose the first proposal that has a reasonable answer to all the required questions.
+-->


Getting-your-thoughts: Should we also say something that it's OK to hide comments if they are off-topic or no longer need to be considered? I think that can be helpful.

Like, maybe if someone doesn't use the proposal template, or they haven't completed all the questions, those are good candidates to be hidden.

I like this, but I'm not sure if C+ has moderation tools available.

You're right, they do not have that. Do you have any idea if it's easily possible to give them moderation ability? I don't know much about how fine-grained the settings are. CC @johnmlee101 or @coleaeason if you know.

So, I just looked this up and there actually is a concept of a "moderator" in GitHub:

https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/managing-moderators-in-your-organization#about-organization-moderators

sounds perfect!

contributingGuides/PROPOSAL_TEMPLATE.md

tgolen · 2023-02-06T14:26:30Z

contributingGuides/CONTRIBUTING.md

-7. Once hired, post a comment in the Github issue stating when you expect to have your PR ready for review 
+5. Refrain from leaving additional comments until someone from the Contributor-Plus team and / or someone from Expensify provides feedback on your proposal (do not create a pull request yet).
+6. If your proposal is accepted by the Expensify engineer assigned to the issue, Expensify will hire you on Upwork and assign the GitHub issue to you.
+7. Once hired, post a comment in the Github issue stating when you expect to have your PR ready for review.


Getting-your-thoughts: Should we say something about only posting one proposal at a time? Oftentimes I see someone will come along and post up to as many as four different proposals. On high-traffic issues, it's a lot to manage.

I think that's a good call out. I think ideally a contributor should only have one "proposal waiting for a review" at a time. Sometimes it happens that you come up with alternate solutions. But I'd argue those belong back the proposal you have open and you should update the current proposal if it hasn't been reviewed yet.

Which also makes me wonder whether we want people to "update their original proposal" or post a new one (since people don't all do this the same way).

Thinking more on all of this and I think my ideal would probably be something like:

Always wait for a response to your current proposal before leaving additional proposals.

It's OK to update a proposal if it hasn't been reviewed yet.

If you're making a new proposal or updating a proposal then edit your original proposal and leave a comment like:

## Proposal [Updated](link to proposal)

Always wait for a response to your current proposal before leaving additional proposals.

maybe that is unclear though. because we are saying it's ok to leave additional proposals. I think it would be better to just have one proposal that the contributor is tweaking and evolving until it's perfect.

Maybe something like...

Do not leave more than one proposal.

Do not make extensive changes to your current proposal until after it has been reviewed.

If you want to make an entirely new proposal or update an existing proposal please go back and edit your original proposal and leave a comment like this:

## Proposal [Updated](link to proposal)

I like the idea of always keeping 1 post per proposal and only having one proposal reviewed at a time. I don't quite get the link to proposal when updating an existing one. If it's all in the same post, then there isn't anything to link to. Plus, GH keeps the edit history of the post anyway.

The thing I dislike is when there is one large proposal that keeps getting tweaked, and so the tweaked proposal exists in several different forms across comments and it's difficult to see what changed between them.

That's why I like just always keeping it in a single post and making updates to the existing post rather than posting a new comment.

If it's all in the same post, then there isn't anything to link to

Ah, so in my head it was a link to the comment which "jumps" you to the proposal in the same issue.

I think the idea with posting an update to a proposal is just that it encourages the best practice of letting everyone know your proposal is "ready for review" again. And then we'd have a general loop of:

Propose

Incorporate feedback

Update proposal

Request re-review

Etc.

This probably happens organically already (perhaps inconsistently) so maybe the attempt to create a process for this seems pointless.

ah, I got you. Just like how we post "updated" on a PR to let people know it can be reviewed again. I like that

…ing proposals.

tgolen · 2023-02-07T15:55:41Z

contributingGuides/CONTRIBUTING.md

@@ -114,6 +114,13 @@ Additionally if you want to discuss an idea with the open source community witho
 4. After you reproduce the issue, complete the [proposal template here](./PROPOSAL_TEMPLATE.md) and post it as a comment in the corresponding GitHub issue (linked in the Upwork job).
    - Note: Before submitting a proposal on an issue, be sure to read any other existing proposals. Any new proposal should be substantively different from existing proposals.
 5. Refrain from leaving additional comments until someone from the Contributor-Plus team and / or someone from Expensify provides feedback on your proposal (do not create a pull request yet).
+    - Do not leave more than one proposal.
+    - Do not make extensive changes to your current proposal until after it has been reviewed.
+    - If you want to make an entirely new proposal or update an existing proposal please go back and edit your original proposal and leave a comment like this:


Suggested change

- If you want to make an entirely new proposal or update an existing proposal please go back and edit your original proposal and leave a comment like this:

- If you want to make an entirely new proposal or update an existing proposal, please go back and edit your original proposal, then post a new comment to the issue in this format to alert everyone that it has been updated:

This adds a little bit of information about why we want the new comment

Yep good clarification. Thanks.

marcaaron · 2023-02-07T16:38:23Z

Updated!

P.S. I think we can look into the moderators thing separately to this. I like the idea of giving C+ the ability to hide comments, but I'm also a little unsure about if we need it yet. I think it's a pretty extreme case where someone internaly has to hide or dismiss a comment. And maybe with more clear instructions we will have even less cases where it's needed.

tgolen

Works for me!

MelvinBot · 2023-02-07T18:38:24Z

@tgolen looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

tgolen · 2023-02-07T18:39:23Z

Oh, yes, I did not fill out the checklist because this is not a code change, only documentation.

OSBotify · 2023-02-07T19:56:28Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.2.67-2 🚀

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

OSBotify · 2023-02-08T23:41:52Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.2.67-7 🚀

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

marcaaron added 2 commits February 3, 2023 07:18

Add proposal template for contributors

37a130c

instructions

8b33dbe

marcaaron self-assigned this Feb 3, 2023

marcaaron added 4 commits February 3, 2023 07:28

Update CONTRIBUTING.md

ceb1c0b

Update CONTRIBUTING.md

ca70861

Update CONTRIBUTING.md

03e76a1

Update CONTRIBUTING.md

7d71198

marcaaron marked this pull request as ready for review February 3, 2023 17:40

marcaaron requested a review from a team as a code owner February 3, 2023 17:40

melvin-bot bot requested review from tgolen and removed request for a team February 3, 2023 17:41

tgolen requested changes Feb 6, 2023

View reviewed changes

Add @tgolen suggestions. Encourage contributors to update their exist…

36ed1cf

…ing proposals.

tgolen requested changes Feb 7, 2023

View reviewed changes

Tell people the reason for posting a comment after updating

edfcbfb

tgolen approved these changes Feb 7, 2023

View reviewed changes

tgolen merged commit 92a606c into main Feb 7, 2023

tgolen deleted the marcaaron-proposalTemplate branch February 7, 2023 18:38

melvin-bot bot added the Emergency label Feb 7, 2023

OSBotify mentioned this pull request Feb 7, 2023

Deploy Checklist: New Expensify 2023-02-07 #14911

Closed

21 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Add proposal template for contributors #14817

[No QA] Add proposal template for contributors #14817

marcaaron commented Feb 3, 2023 •

edited

Loading

melvin-bot bot commented Feb 3, 2023

tgolen left a comment

tgolen Feb 6, 2023

tgolen Feb 6, 2023

marcaaron Feb 6, 2023

tgolen Feb 6, 2023

marcaaron Feb 6, 2023

tgolen Feb 6, 2023

tgolen Feb 6, 2023

marcaaron Feb 6, 2023

marcaaron Feb 6, 2023 •

edited

Loading

marcaaron Feb 6, 2023

tgolen Feb 6, 2023

marcaaron Feb 6, 2023

tgolen Feb 6, 2023

tgolen Feb 7, 2023

marcaaron Feb 7, 2023

marcaaron commented Feb 7, 2023

tgolen left a comment

MelvinBot commented Feb 7, 2023

tgolen commented Feb 7, 2023

OSBotify commented Feb 7, 2023

OSBotify commented Feb 8, 2023

	- If you want to make an entirely new proposal or update an existing proposal please go back and edit your original proposal and leave a comment like this:
	- If you want to make an entirely new proposal or update an existing proposal, please go back and edit your original proposal, then post a new comment to the issue in this format to alert everyone that it has been updated:

[No QA] Add proposal template for contributors #14817

[No QA] Add proposal template for contributors #14817

Conversation

marcaaron commented Feb 3, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 3, 2023

tgolen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcaaron Feb 6, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcaaron commented Feb 7, 2023

tgolen left a comment

Choose a reason for hiding this comment

MelvinBot commented Feb 7, 2023

tgolen commented Feb 7, 2023

OSBotify commented Feb 7, 2023

OSBotify commented Feb 8, 2023

marcaaron commented Feb 3, 2023 •

edited

Loading

marcaaron Feb 6, 2023 •

edited

Loading