Skip to content

Latest commit

 

History

History
79 lines (53 loc) · 4.58 KB

CONTRIBUTING.md

File metadata and controls

79 lines (53 loc) · 4.58 KB
Raw

Contributing Code

First Steps

  1. Phone a friend: The first step is always to chat up folks on #green-up on Slack. Visit our channel here or if it's your first time, get an invitation here.

  2. Get a Dev Environment Running: Our "Full Local Environment" setup is up to date as of 03 April 2022.

  3. Check the Project Board: We have our open software tickets organized under projects. If you're new to the project, look for those labeled as 'good first issue'.

  4. Dial Tech Support: If you have trouble at any point we have a dedicated slack channel for that. Join the #tech-support channel and someone will help you out asap.

  5. Get to work! See How to Contribute Your Work below.

Environment Setup

A Full Local Environment

  1. Get a Config File: You won't be able to run the code without a firebase-config.js file. The fastest approach is to use our shared dev environment (..which we share, so please treat it kindly). There is one pinned to the #green-up Slack channel for our dev environment. If you have trouble finding it, just ask anyone in the channel. Save your firebase-config.js in the root of the project.

  2. (Optional) Use Your Own Firebase Account: Setup a Firebase app and use those app settings to configure firebase-config.js,
    Get your own Firebase database here (https://firebase.google.com/) or, if you want to contribute to this project, find us on Slack and we'll gladly share ours. Not on our Slack board? Get an invitation.

  3. Ensure you have nvm installed: Do this by running nvm ls. If you see a list of node versions printed to your console, then you're all set. Otherwise, follow the setup instructions.

  4. Install Project Dependencies:

nvm install v16.19.1
nvm use v16.19.1
# optional nvm alias green-up v16.19.1
npm install --legacy-peer-deps
npm install -g expo-cli
npm install -g flow

  1. Download the Expo App: The Green Up app is configured to be run on your physical phone inside the Expo mobile app (aka the "Expo Client"). Expo is a shell that runs the unpublished mobile app.

  2. Start the Application: Run the project in the root folder.

expo-cli start

  1. Profit! When the giant QR code appears in the editor...

    • iPhones: point your camera at the QR code and the app will launch in expo
    • Android: open the Expo mobile app and click "Scan QR Code"

    This will open the app on your phone. Now create an account and begin exploring!

How to Contribute Your Work

To contribute, send us a pull request. Our team will do our best to review it on time and merge it to master.

  1. If you're working on an existing issue, assign it to yourself and drag it to the 'In Progress' column in the project it's assigned to.
  2. Create a branch from master. If you don't have permissions to create a branch, fork the repository. If the change you're making belongs to an issue, use the issue number as the branch name e.g issue-22
  3. Make the changes in your branch.
  4. Commit the changes to your branch using a clear and descriptive commit message.
  5. Push the changes to your branch.
  6. Make sure that your branch has the latest source from the master branch.
  7. Create a pull request either from your fork or your branch. Include any relevant information about your changes in the pull request description
  8. Address any questions from the pull request
  9. Once the pull request has been accepted and merged to master be sure to delete your branch and drag the corresponding issue (if any) to the 'Done' column.

Code of Conduct

This project has adopted the Code for BTV Code of Conduct.

Licensing

See the LICENSE for information on this project's license.