Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 3.56 KB

CONTRIBUTING.md

File metadata and controls

36 lines (27 loc) · 3.56 KB

Contributing to Expensify.cash

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. The part of the README to pay particular attention to is how to run the app locally using our production API.

Test Accounts

You can create as many accounts as needed in order to test your changes. You can create your test accounts directly from expensify.cash. Right now, accounts can't chat with each other by default. If you want your test accounts to be able to chat with each other, post in the #expensify-contributors Slack channel to ask someone to add your test accounts to a policy that allows chatting.

Code of Conduct

This project and everyone participating in it is governed by the Expensify Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

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 [email protected] with the subject "Slack Channel Invite" and we'll send you an invite! Please do not create issues to ask questions.

Reporting Vulnerabilities

If you've found a vulnerability, please email [email protected] with the subject Vulnerability Report instead of creating an issue.

Filing Issues

If you'd like to create a new issue, please first make sure the issue does not exist in the issue list. When creating a new issue, please include all the required information on the issue template.

Payment for Contributions

We are currently managing payment via Upwork. If you'd like to be paid for your contributions, please apply to fix the issue from our Upwork issue list. Each issue in this repo will also link out to the associated Upwork job.

Submitting a Pull Request

Proposing a Change

  1. Fork this repository and create a new branch
  2. Open a PR. Be sure to fill in all the required information on the PR template, and be sure all of your commits are signed.
  3. An Expensify engineer will be automatically assigned to review your PR
  4. You will need all checks to pass:
    1. CLA - You must sign our Contributor License Agreement by following the CLA bot instructions that will be posted on your PR
    2. Tests - All tests must pass before a merge of a pull request
    3. Lint - All code must pass lint checks before a merge of a pull request

Testing

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.