Skip to content

Latest commit

 

History

History
108 lines (78 loc) · 4.13 KB

CONTRIBUTING.md

File metadata and controls

108 lines (78 loc) · 4.13 KB
Raw

Contributing

Issues / milestones

We try to prioritize issues by assigning them to milestones. The closer a milestone is, the more priority an issue has. When an issue doesn't have a milestone it's not prioritized yet.

Prerequisites

You will need the following things properly installed on your computer.

Installation

  • git clone <repository-url> this repository
  • change into the new directory
  • Create a new github application
    • Go to github.com
    • click top right portrait
    • click on 'Settings'
    • select 'Developer settings'
    • click on 'New OAuth App' button
    • name it whatever you want (ember-twiddle-dev if you can't think of anything)
    • set the homepage url to any valid URL (http://google.com, since it doesn't actually matter)
    • set the 'Authorization callback URL' to: http://localhost:4200/
    • click 'Register application'
    • leave this tab open, we're going to need to id and secret later
  • Install gatekeeper
  • Edit the gatekeeper config.json to have the client_id and client_secret from your new github application
  • Edit the config/environment.js in ember twiddle (find the apiKey and set it to the client_id of your github application)
    • Note: If you are going to use Docker setup, instead of editing config/environment.js, open the docker-compose.yml and under environment change CHANGEME with your key

Running / Development Without Docker (Recommended)

  • node index.js from your gatekeeper folder
  • yarn from ember twiddle folder
  • ember server from ember twiddle folder
  • Visit your app at http://localhost:4200.

Running / Development With Docker (OPTIONAL)

Docker has been setup to make things easier to get setup and working.

Additional Dependencies

Instructions

First thing you want to do is edit the docker-compose.yml file and change the CHANGEME to match your keys and secrets. Then you will want to run the following commands:

# Pull gatekeeper code
$ git submodule init
$ git submodule update

# Start Docker
$ docker-compose up

# When you are done coding, to stop the container, hit Ctrl+C
$ docker-compose stop

# When you want to start again
$ docker-compose start

Visit the app at http://localhost:4200.

Code Generators

Make use of the many generators for code, try ember help generate for more details

Running Tests

  • ember test
  • ember test --server

Building

  • ember build (development)
  • ember build --environment production (production)

Design

  • Follow the Ember styleguide.
  • Do not use any Ember trademarked items, including:
    • Tomster
    • Ember logo
  • Otherwise, try to keep the overall theme as close to other Ember websites as possible.

Suggestions

  • Try to only fix one issue and/or upgrade one version. You are more likely to be able to succeed.
  • Upgrading the ember-cli version is extremely difficult, because we are using private apis. Try to upgrade in small pieces. Consider forking ember-cli during the upgrade process to upgrade its dependencies one by one. Don't forget to revert to a standard ember-cli version when done.
  • Add tests with your PR.
  • Upgrading ember-cli is usually not necessary to upgrade Ember or Ember Data.
  • New Ember versions will not work without upgrades to the backend.
  • The backend does not have tests. Until it does, please test by actually compiling addons with Docker and an AWS account before submitting PRs.
  • If you are going to use a local backend, make changes to environment.js using git update-index skip-worktree [<file>...] so that changes to your environment.js are not accidentally committed.