Update CONTRIBUTING.md #1715

michaelhaxhiu · 2021-03-11T00:34:53Z

Work in progress on updating the Contributor Guidelines

Details

Contributor.md copy updates that we shared in Slack here

Fixed Issues

https://github.com/Expensify/Expensify/issues/154933

Work in progress on updating the Contributor Guidelines

github-actions · 2021-03-11T00:35:11Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

pecanoro · 2021-03-11T09:53:43Z

Hax, the little bot wants you to sign the CLA before I can merge by following what it says here #1715 (comment)

michaelhaxhiu · 2021-03-11T12:28:21Z

Rocio, thanks for defending me from the bots! We aren't ready to merge this juuuust yet, but I will take you up on a review when it's finalized (if you are offering it 😄 )

CONTRIBUTING.md

Jag96 · 2021-03-11T17:16:29Z

CONTRIBUTING.md

- Please do NOT ping individual reviewers in the Slack channel to get their attention and keep the conversation in GitHub whenever possible.
- Patience is a virtue. Reviews can sometimes take place over the course of several days. If your PR has not been addressed after 3 days please leave a comment on the PR. If the PR goes without a response for another day please let us know via Slack.
-
-### JavaScript Style


Coming from https://expensify.slack.com/archives/C011W8BJ9L6/p1615481353152800?thread_ts=1615345614.094600&cid=C011W8BJ9L6, let's keep this section here

CONTRIBUTING.md

marcaaron

Looks good, but I think we have leaned this doc out a little too much

marcaaron · 2021-03-11T17:12:54Z

CONTRIBUTING.md

@@ -2,59 +2,64 @@
 Welcome! Thanks for checking out Expensify.cash and for taking the time to contribute!

 ## Getting Started
-This guide is specifically for external contributors. For a general overview of the repo, check out our README located [here](https://github.com/Expensify/Expensify.cash/blob/master/README.md). The part of the README to pay particular attention to is how to [run the app](https://github.com/Expensify/Expensify.cash#local-development) locally using our production API.
+This guide is for external contributors. Check out our README guidelines here for a general overview of the code repository, how to run the app locally, testing, storage, etc. 


This guide is for external contributors.

NAB, this is sort of implied since it's a CONTRIBUTING.md

Updated the phrasing to be more accurate. Hopefully it's better now?

CONTRIBUTING.md

marcaaron · 2021-03-11T17:36:22Z

CONTRIBUTING.md

- Please do NOT ping individual reviewers in the Slack channel to get their attention and keep the conversation in GitHub whenever possible.
- Patience is a virtue. Reviews can sometimes take place over the course of several days. If your PR has not been addressed after 3 days please leave a comment on the PR. If the PR goes without a response for another day please let us know via Slack.
-
-### JavaScript Style


As mentioned in Slack, I'd like to see this stuff back in here.

Cool, adding back

CONTRIBUTING.md

Jag96

Looking good, just a couple of requests

Jag96 · 2021-03-16T18:16:34Z

CONTRIBUTING.md


 ## Code of Conduct
 This project and everyone participating in it is governed by the Expensify [Code of Conduct](https://github.com/Expensify/Expensify.cash/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [contributors@expensify.com](mailto:contributors@expensify.com).

 ## Asking Questions
-The best way to ask questions is to join our #expensify-contributors Slack channel. To request an invite to the channel, just email contributors@expensify.com with the subject "Slack Channel Invite" and we'll send you an invite! Please do not create issues to ask questions.
+If you have any general questions, please ask in the #expensify-contributors Slack channel. To request an invite to the channel, just email contributors@expensify.com with the subject `Slack Channel Invite` and we'll send you an invite! The Expensify team will not be able to respond to direct messages in Slack.


I think we should still clarify that GH issues shouldn't be created for the sole purpose of asking questions.

Hm I don't agree because I think we start opening the path to listing all ways to not ask a question if we do this type of approach. Right now I think it's really clear how/when to ask questions, and if we see someone violate that rule we just treat it like our manifesto (point them to the Contributing.md or Readme.md files, and ask them to re-read it).

I feel like listing it out is too exhaustive and specific - like we wouldn't want to get caught up saying "don't ask questions by... making new GH issues, messaging us in Upwork, emailing contributors@expensify.com, posting on the community, reaching out to concierge, etc"

Can we try out this suggestion, and circle back to update this copy if it's still generating issues to make the update you are proposing? I'm really hoping to keep brevity here so people actually read this guide 🤞 (but hey, time will tell if these edits actually help lol)

Yeah, that works! We originally included it there since it is common for GH issues to be used to ask questions in open-source repositories, but I agree we can always re-add it if it actually becomes a problem

since it is common for GH issues to be used to ask questions in open-source repositories

This argument is the first one I'll remember if contributors continue to do this in the future (I've never been an external contributor of another project so I didn't know this!). Let me know if our contributors keep doing this.

Probably fine to take out, but I agree that we don't want people creating GH issues to ask questions.

Jag96 · 2021-03-16T18:20:23Z

CONTRIBUTING.md

-Upon submission of a PR, please include a numbered list of explicit testing steps for each platform (Web, Desktop, iOS, and Android) to confirm the fix works as expected and there are no regressions.
-
-#### Review Tips
+9. Open a pull request, and make sure to fill in the required fields.


I think we should re-add the GH link for creating a pull request from a fork here so it's clear.

That's a candid mistake on my end, adding it now and resolving this one.

Jag96 · 2021-03-16T18:22:08Z

CONTRIBUTING.md

@@ -38,23 +67,16 @@ We are currently managing payment via Upwork. If you'd like to be paid for your
    [gpg]
        program = gpg
    ```
-1. [Open a PR](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). Be sure to fill in all the required information on the PR template.
-1. An Expensify engineer will be automatically assigned to review your PR
-1. You will need all checks to pass:


I think these are still important to highlight, including the CLA link. Is there a reason we removed this?

Oversight on my part - as I thought we captured the part that was important, and didn't deem CLA stuff as fitting the bill. Apologies 😄, fixing now

Jag96

Looks good! Will leave open for @marcaaron to review

michaelhaxhiu · 2021-03-16T19:46:06Z

I have read the CLA Document and I hereby sign the CLA.

michaelhaxhiu · 2021-03-16T19:46:10Z

recheck

marcaaron · 2021-03-19T16:40:09Z

CONTRIBUTING.md

+
+#### Begin coding your solution in a pull reuqest
+7. When you are ready to start, fork the repository and create a new branch.
+8. Before you begin writing any code, please be aware that we require all commits to be [signed](https://docs.github.com/en/github/authenticating-to-github/signing-commits). The easiest way to do that is to [generate a new GPG key](https://docs.github.com/en/github/authenticating-to-github/generating-a-new-gpg-key) and [add it to your Github account](https://docs.github.com/en/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account). Once you've done that, you can automatically sign all your commits by adding the following to your `.gitconfig`:


We lost the emphasis here. This step gets missed a lot 🤷

marcaaron

LGTM.

Update CONTRIBUTING.md

b922b6d

Work in progress on updating the Contributor Guidelines

michaelhaxhiu requested a review from a team as a code owner March 11, 2021 00:34

botify requested review from pecanoro and removed request for a team March 11, 2021 00:35

Jag96 suggested changes Mar 11, 2021

View reviewed changes

marcaaron requested changes Mar 11, 2021

View reviewed changes

michaelhaxhiu added 3 commits March 15, 2021 14:53

Update CONTRIBUTING.md

9c12f32

Update CONTRIBUTING.md

dfd836d

Update CONTRIBUTING.md

6e701b6

michaelhaxhiu removed the request for review from pecanoro March 16, 2021 16:08

Jag96 suggested changes Mar 16, 2021

View reviewed changes

Update CONTRIBUTING.md

3795e64

Jag96 approved these changes Mar 16, 2021

View reviewed changes

marcaaron reviewed Mar 19, 2021

View reviewed changes

marcaaron approved these changes Mar 19, 2021

View reviewed changes

marcaaron merged commit e436274 into Hax-contributor-updates Mar 19, 2021

marcaaron deleted the michaelhaxhiu-contributor-patch-1 branch March 19, 2021 16:41

github-actions bot locked and limited conversation to collaborators Mar 19, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update CONTRIBUTING.md #1715

Update CONTRIBUTING.md #1715

michaelhaxhiu commented Mar 11, 2021 •

edited

Loading

github-actions bot commented Mar 11, 2021 •

edited

Loading

pecanoro commented Mar 11, 2021

michaelhaxhiu commented Mar 11, 2021 •

edited

Loading

Jag96 Mar 11, 2021

marcaaron left a comment

marcaaron Mar 11, 2021

michaelhaxhiu Mar 16, 2021

marcaaron Mar 11, 2021

michaelhaxhiu Mar 16, 2021

Jag96 left a comment

Jag96 Mar 16, 2021

michaelhaxhiu Mar 16, 2021

michaelhaxhiu Mar 16, 2021

Jag96 Mar 16, 2021

michaelhaxhiu Mar 16, 2021

marcaaron Mar 19, 2021

Jag96 Mar 16, 2021

michaelhaxhiu Mar 16, 2021

Jag96 Mar 16, 2021

michaelhaxhiu Mar 16, 2021

Jag96 left a comment

michaelhaxhiu commented Mar 16, 2021

michaelhaxhiu commented Mar 16, 2021

marcaaron Mar 19, 2021

marcaaron left a comment

Update CONTRIBUTING.md #1715

Update CONTRIBUTING.md #1715

Conversation

michaelhaxhiu commented Mar 11, 2021 • edited Loading

Details

Fixed Issues

github-actions bot commented Mar 11, 2021 • edited Loading

pecanoro commented Mar 11, 2021

michaelhaxhiu commented Mar 11, 2021 • edited Loading

Choose a reason for hiding this comment

marcaaron 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

Jag96 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jag96 left a comment

Choose a reason for hiding this comment

michaelhaxhiu commented Mar 16, 2021

michaelhaxhiu commented Mar 16, 2021

Choose a reason for hiding this comment

marcaaron left a comment

Choose a reason for hiding this comment

michaelhaxhiu commented Mar 11, 2021 •

edited

Loading

github-actions bot commented Mar 11, 2021 •

edited

Loading

michaelhaxhiu commented Mar 11, 2021 •

edited

Loading