-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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 #6887
Update CONTRIBUTING.md #6887
Conversation
Suggested a few edits in slack :D |
CONTRIBUTING.md
Outdated
@@ -89,7 +89,7 @@ It’s possible that you found a bug or enhancement that we haven’t posted to | |||
``` | |||
9. [Open a pull request](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork), and make sure to fill in the required fields. | |||
10. An Expensify engineer and a member from the Contributor-Plus team will be assigned to your pull request automatically to review. | |||
11. Provide daily updates until reaching completion of your PR. | |||
11. Daily updates on weekdays are expected. If there is a plan for no updates for a while we expect the courtesy to be informed about the duration there will be no work so that we may plan accordingly. Any issue without an update for 1 week with no explanation why there is no progress will be considered abandoned and will likely be closed or reassigned, and the original contract will be terminated. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just pulling in that feedback from Alex B since I liked the phrasing and adding a few things for tone...
Daily updates on weekdays are highly recommended.
If you know you won’t be able to provide updates for > 1 week, please comment on the PR or issue how long you plan to be out so that we may plan accordingly. We understand everyone needs a little vacation here and there.
This could maybe be shortened
Any issue that doesn't receive an update after 1 week may be considered abandoned and the original contract terminated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this phrasing is very clear:
Daily updates on weekdays are highly recommended. Any issue that doesn't receive an update after 1 week may be considered abandoned and the original contract terminated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love the shortened point 👍 I think it could be nice to touch up the phrase "Any issue that doesn't receive an update after 1 week may be considered abandoned..." - Something like this:
Any issue that doesn't receive an update for 1 full week may be considered abandoned...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will you be updating the copy here @mallenexpensify or would you like one of us to update it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can one of you update the copy (if only cuz I'm not sure of the fastest/best way to do it :ohnothing:)
Updated copy, ready for re-review. |
@@ -89,7 +89,7 @@ It’s possible that you found a bug or enhancement that we haven’t posted to | |||
``` | |||
9. [Open a pull request](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork), and make sure to fill in the required fields. | |||
10. An Expensify engineer and a member from the Contributor-Plus team will be assigned to your pull request automatically to review. | |||
11. Provide daily updates until reaching completion of your PR. | |||
11. Daily updates on weekdays are highly recommended. If you know you won’t be able to provide updates for > 1 week, please comment on the PR or issue how long you plan to be out so that we may plan accordingly. We understand everyone needs a little vacation here and there. Any issue that doesn't receive an update for 1 full week may be considered abandoned and the original contract terminated. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could be wrong, but I thought @marcaaron 's comment here was suggesting we replace these two sentences:
If you know you won’t be able to provide updates for > 1 week, please comment on the PR or issue how long you plan to be out so that we may plan accordingly. We understand everyone needs a little vacation here and there.
With this 1 sentence:
Any issue that doesn't receive an update for 1 full week may be considered abandoned and the original contract terminated.
That being said, I'm pretty happy with the full text we have now 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
His comment posted 3 new phrases compared to the earlier so I read it like so,
We can replace,
Daily updates on weekdays are expected.
with
Daily updates on weekdays are highly recommended.
Replace,
If there is a plan for no updates for a while we expect the courtesy to be informed about the duration there will be no work so that we may plan accordingly.
with,
If you know you won’t be able to provide updates for > 1 week, please comment on the PR or issue how long you plan to be out so that we may plan accordingly. We understand everyone needs a little vacation here and there.
Replace,
Any issue without an update for 1 week with no explanation why there is no progress will be considered abandoned and will likely be closed or reassigned, and the original contract will be terminated.
with,
Any issue that doesn't receive an update after 1 week may be considered abandoned and the original contract terminated.
So thats how i inferred it. We can wait for @marcaaron to confirm as well too but if we update it such the point is only,
Any issue that doesn't receive an update after 1 week may be considered abandoned and the original contract terminated.
then i feel like it doesn't capture this point which i feel is important,
If you know you won’t be able to provide updates for > 1 week, please comment on the PR or issue how long you plan to be out so that we may plan accordingly. We understand everyone needs a little vacation here and there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like where this landed. Nice edits @chiragsalian!
@@ -89,7 +89,7 @@ It’s possible that you found a bug or enhancement that we haven’t posted to | |||
``` | |||
9. [Open a pull request](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork), and make sure to fill in the required fields. | |||
10. An Expensify engineer and a member from the Contributor-Plus team will be assigned to your pull request automatically to review. | |||
11. Provide daily updates until reaching completion of your PR. | |||
11. Daily updates on weekdays are highly recommended. If you know you won’t be able to provide updates for > 1 week, please comment on the PR or issue how long you plan to be out so that we may plan accordingly. We understand everyone needs a little vacation here and there. Any issue that doesn't receive an update for 1 full week may be considered abandoned and the original contract terminated. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like where this landed. Nice edits @chiragsalian!
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
🚀 Deployed to staging by @marcaaron in version: 1.1.24-19 🚀
|
🚀 Deployed to production by @francoisl in version: 1.1.24-19 🚀
|
Discussion here https://expensify.slack.com/archives/C01SKUP7QR0/p1640212812255600?thread_ts=1640200344.249400&cid=C01SKUP7QR0
Details
Adding more details about expected frequency of updates
Fixed Issues
Only text in CONTRIBUTING.md
Tests
Check to see https://github.com/Expensify/App/blob/main/CONTRIBUTING.md is updated.
QA Steps
Tested On
Screenshots
Web
Mobile Web
Desktop
iOS
Android