Skip to content

Commit

Permalink
Adding initial project
Browse files Browse the repository at this point in the history
  • Loading branch information
SpencerKaiser committed Jul 20, 2020
0 parents commit 1792121
Show file tree
Hide file tree
Showing 47 changed files with 10,713 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .cfignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
node_modules
.github
src
coverage
3 changes: 3 additions & 0 deletions .env.sample
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
PORT="3000"
SLACK_SIGNING_SECRET="XXX"
SLACK_TOKEN="XXX"
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Project owners
# Spencer Kaiser
* @spencerkaiser
39 changes: 39 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Hey there 👋
First off, thanks for stopping by! At American, we're passionate about building products that improve the experience of our customers through technology. To do this, we focus on providing our devs with the tools they need to make their work as easy and enjoyable as possible. This project, along with our other open source projects, is something we use internally and we hope it helps you as well.

If you're reading this, you're likely interested in contributing to the project. We're excited about your contribution, but please take a moment to read our the info below before getting started.

## Bugs & Feature Requests
Whether you found something that isn't working correctly, something could be improved, or you'd like to suggest a feature, please start with the tasks below.

### Existing Issues
Search through this project's [issues](../../../issues) and see if your issues/suggestion is already being tracked. If you find something that matches your issue, join the conversation!

### Create an Issue

#### Bugs
If you didn't find what you were looking for, [create a new issue](../../../issues/new) and fill in the required fields to help steer us in the right direction. We'll check it out and get back to you when we can.

#### Feature Requests
If you didn't find what you were looking for, [create a new issue](../../../issues/new) with a title starting with `[Feature Request] -` to help us differentiate it from a bug. Delete the pre-populated description and give us as much information as you can about the feature you'd like to see added. We'll review your request and get back to you. If we feel it's something that fits well with our project goals, we'll verify the

## Contributing

### Finding Something to Work On
To help you get started, we've marked some tasks with the `help-welcome` and `good-first-task` labels. While browsing, make sure there isn't an assignee on the issue and make sure to read through the issue activity to make sure no one else is working on it. When you find something you want to work on, comment on the issue and let the team know you'd like to work on it.

### Forking and Pull Requests
When you're ready to start writing code, make sure you [fork](https://help.github.com/articles/fork-a-repo/) this repo and use that fork to make your changes. Once you have something worth sharing, open a [Draft Pull Request](https://github.blog/2019-02-14-introducing-draft-pull-requests/) and make sure to include a reference to the issue (e.g., `Fixes #25` at the bottom of the PR description):
1. Use the `master` branch as your PR's base branch
1. Make sure your PR branch is as up-to-date as possible (we'll handle merge conflicts if one arises)
1. Fill out all fields suggested by the template, including links to issue(s) your PR addresses which will help prevent duplication of efforts (e.g., `Fixes #25` at the bottom of the PR description)
1. If it's your first contribution, make sure your PR includes a modification to `AUTHORS.md` to include your first and last name as well as your email address _or_ your GitHub handle
1. If you aren't ready for your changes to be merged when you open the pull request, please open a [Draft Pull Request](https://github.blog/2019-02-14-introducing-draft-pull-requests/).

**Note**: if you work several issues at once, make sure they're addressed in separate PRs, on separate branches, and all have a base of `master` from this repo

#### Attribution
If your contribution uses code from another source, make sure you properly attribute it. Cite the source of your code where the code is used and include attribution in `ThirdPartyNotices.md`. Both of these must be present in your PR before we'll merge.

## Contributor License Agreement
By contributing to Hangar, you agree to the terms of American’s [Contributor License Agreement](https://github.com/AmericanAirlines/Contributor-License-Agreement/blob/master/CLA.md).
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Bug report
about: Create a report to help us improve. Please make sure to use a descriptive title for the issue.
labels: bug
---

## Pre-requisites:
<!-- Add a check to each item below by replacing "[ ]" with "[x]" (no spaces inside the brackets, lowercase x) -->
- [ ] Yes, I looked through both [open and closed issues](../../../issues?utf8=✓&q=is%3Aissue) looking for what I needed
- [ ] No, I did not find what I was looking for

## Description
<!-- Enter a description of the issue/enhancement below -->

## Expected Behavior
<!-- What should have happened? -->

## Actual Behavior
<!-- What actually happened? -->

## Repro Steps
<!-- Be as descriptive as possible -->

## Other Information
<!-- Feel free to include versions, logs, screenshots, etc. if it will help with debugging -->
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Feature Request
about: Make a Feature Request
labels: Feature request, needs review
---

### Pre-requisites:
<!-- Add a check to each item below by replacing "[ ]" with "[x]" (no spaces inside the brackets, lowercase x) -->
- [ ] Yes, I looked through both [open and closed issues](../../../issues?utf8=✓&q=is%3Aissue) looking for what I needed

## Feature Description
<!-- What does your new feature do? How would users interact with it/use it? -->

## Additional Details
<!-- This is your space to add anything you think is relevant -->
12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## Pre-Requisites
- [ ] Yes, I updated [Authors.md](../Authors.md) **OR** this is not my first contribution
- [ ] Yes, I included and/or modified tests to cover relevent code **OR** my change is non-technical
- [ ] Yes, I wrote this code entirely myself **OR** I properly attributed these changes in [Third Party Notices](../THIRD-PARTY-NOTICES.txt)

## Description of Changes
<!-- Enter a description of what this PR adds/changes -->

## Related Issues
<!-- Include a list and brief description of any tracked issues -->
<!-- e.g., "Fixes #123 - A bug that crashes the app" -->
<!-- NOTE: Each bugfix needs to use the "Fixes" or "Closes" and needs to be on its own line -->
25 changes: 25 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Build

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [12.x, 14.x]

steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- run: npm ci
- run: npm run build
- run: npm run lint
- run: npm run prettier
25 changes: 25 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Test

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [12.x, 14.x]

steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: Test
run: |
npm ci
npm run test:coverage
61 changes: 61 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
dist
.DS_Store

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
typings/

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
3 changes: 3 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.npm
node_modules
coverage
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.github/
*.md
8 changes: 8 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"arrowParens": "always",
"printWidth": 120,
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "all",
"useTabs": false
}
3 changes: 3 additions & 0 deletions Authors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Authors

- Spencer Kaiser ([email protected])
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the [project team](mailto:[email protected]). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 American Airlines

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading

0 comments on commit 1792121

Please sign in to comment.