Skip to content

Commit

Permalink
chore: init beta release
Browse files Browse the repository at this point in the history
  • Loading branch information
housed committed Jun 27, 2019
0 parents commit 29ab62e
Show file tree
Hide file tree
Showing 102 changed files with 17,136 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# http://editorconfig.org
root = true

[*]
charset = utf-8
insert_final_newline = true
trim_trailing_whitespace = true

[{*.js,*.json,*.yml}]
indent_size = 2
indent_style = space
12 changes: 12 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package-lock.json -diff -merge
package-lock.json linguist-generated=true

# Set the default behavior, in case people don't have core.autocrlf set.
* text=auto

# Force code files to use lf for linting
*.js eol=lf
*.ts eol=lf

# Force the bash scripts to be checked out with LF line endings.
*.bash text eol=lf
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: New Issue
about: This is not a feature or a bug
title: 'Issue: '
labels: ''
---

# Issue Details

## Current SDK Version

## Current Behavior

## Desired Behavior

## Additional Information

```javascript
// code samples
```
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Create bug report
about: Tell us about an issue
title: 'Bug: '
labels: 'bug'
---

# Bug Report

## SDK Version

## Current Behavior

## Expected Behavior

## Steps to Reproduce

## Additional Information

<!-- Any additional useful information goes here -->
## Operating System

## Node Version

```javascript
// code samples
```
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: New feature request
about: Help us improve our software
title: 'Feature: '
labels: 'feature'
---

# Feature Request

## Current SDK Version

## Current Behavior

## Desired Behavior

## Additional Information

```javascript
// code samples
```
55 changes: 55 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Title

<!--- Provide a general summary of your changes in the Title above -->

## Description

<!--- Describe your changes in detail -->

## Issue link(s) - Optional

<!--- Link issue(s) in this section --->

## Motivation and Context

<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open [issue][issues], please link to the issue here -->

## Testing

<!--- Please describe in detail how you tested your changes -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Screenshots (if appropriate)

## Types of changes

<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Checklist

<!--- Go over all the following points, and put an `x` in all the boxes that apply -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [ ] My code follows the code style of this project
- [ ] My change requires a change to the documentation
- [ ] I have updated the documentation accordingly
- [ ] I have read the **README** document
- [ ] I have added tests to cover my changes
- [ ] All new and existing tests passed

## License

<!--- This Skills GameOn SDK for Node.js is released under the [Apache License, Version 2.0][license], so any code you submit will be released under that license -->
<!--- For substantial contributions, we may ask you to sign a [Contributor License Agreement (CLA)][cla] -->
<!--- Put an `x` in the below box if you confirm that this request can be released under the Apache 2 license -->
- [ ] I confirm that this pull request can be released under the Apache 2 license

[issues]: https://github.com/alexa-games/skills-gameon-sdk-js/issues
[license]: https://www.apache.org/licenses/LICENSE-2.0
[cla]: http://en.wikipedia.org/wiki/Contributor_License_Agreement
2 changes: 2 additions & 0 deletions .github/semantic.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Always validate the PR title, and ignore the commits
titleOnly: true
26 changes: 26 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.DS_Store
node_modules
packages/**/lib
package-lock.json

# Ignore auto generated docs, but keep the theme
docs/*
!docs/theme
!docs/theme/*
docs/theme/.DS_Store

# AWS-specific
**/aws-config.json

# Lerna Tool
lerna-debug.log

# JetBrains Tools
.idea

# VsCode
.vscode

# Coverage directory used by tools like istanbul
coverage
.nyc_output
11 changes: 11 additions & 0 deletions .mailmap
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#
# This list is used by git-shortlog to fix a few botched name translations
# in the git archive, either because the author's full name was messed up
# and/or not always written the same way, making contributions from the
# same person appearing not to be so.
#
# Examples <[email protected]> <[email protected]>
# First Last <[email protected]> <[email protected]>
Dylan House <[email protected]> <[email protected]>
Dylan House <[email protected]> <[email protected]>
Alexa Games <[email protected]> <[email protected]>
68 changes: 68 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
language: node_js

node_js:
- '12'
- '11'
- '10'
- '9'
- '8'

os:
- linux
- osx

git:
depth: false

cache:
directories:
- $HOME/.npm
- node_modules
- packages/*/node_modules

stages:
- name: compile
- name: lint
- name: test
- name: nightly
if: type = cron AND branch = develop
- name: publish
if: branch = master AND type = push AND tag IS blank

jobs:
include:
- stage: compile
name: 'Compile'
script: npm run build
before_script:
- echo "$TRAVIS_EVENT_TYPE"
- echo "$TRAVIS_COMMIT"
- echo "$TRAVIS_BRANCH"
- echo "$TRAVIS_TAG"
- stage: lint
name: 'Code Lint'
script: npm run lint
- stage: nightly
name: 'Nightly Build'
script:
- npm run build
- lerna publish --yes --canary --preid nightly.$TRAVIS_BUILD_ID --dist-tag nightly
before_script:
- echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" >> $HOME/.npmrc 2> /dev/null
- stage: publish
name: 'Publish'
script:
- npm run build
- lerna version --github-release --conventional-commits --yes
- lerna publish from-git --yes
before_script:
- echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" >> $HOME/.npmrc 2> /dev/null
- git config user.email $GH_EMAIL
- git config user.name $GH_NAME
- git remote set-url origin https://[email protected]/$TRAVIS_REPO_SLUG.git
- git checkout master
after_script:
- git fetch
- git checkout -t origin/develop
- git merge master
- git push
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Change Log

All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
8 changes: 8 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Code of Conduct

This project has adopted the
[Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
For more information see the
[Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
[[email protected]](mailto:[email protected])
with any additional questions or comments.
102 changes: 102 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# Contributions Welcome

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
information to effectively respond to your bug report or contribution.

If you're looking to report a bug or have an idea, follow the [bug and potential feature workflow](#Reporting Bugs and Potential Features). or chat with
us on the [Slack|Gitter|X channel](https://github.com/alexa-games/skills-gameon-sdk-js).

Follow the [contribution workflow](#contribution-workflow) for submitting your
changes to the Skills GameOn SDK for Node.js codebase. If you want to receive high-level but still
commit-based feedback for a contribution, follow the
[request for comments](#request-for-comments) steps instead.

## Reporting Bugs and Potential Features

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check [existing open](https://github.com/alexa-games/skills-gameon-sdk-js/issues), or [recently closed](https://github.com/alexa-games/skills-gameon-sdk-js/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

* A reproducible test case or series of steps
* The version of our code being used
* Any modifications you've made relevant to the bug
* Anything unusual about your environment or deployment

## Contribution Workflow

Skills GameOn SDK for Node.js uses the “fork-and-pull” development model. Follow these steps if
you want to merge your changes to Skills GameOn SDK for Node.js:

1. Within your fork of
[Skills GameOn SDK for Node.js](https://github.com/alexa-games/skills-gameon-sdk-js), create a
branch for your contribution. Use a meaningful name.
1. Create your contribution, meeting all
[contribution quality standards](#contribution-quality-standards)
1. [Create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)
against the develop branch of the Skills GameOn SDK for Node.js repository.
1. Add two reviewers to your pull request (a maintainer will do that for you if
you're new). Work with your reviewers to address any comments and obtain a
minimum of 2 approvals, at least one of which must be provided by
[a maintainer](MAINTAINERS.md).
To update your pull request amend existing commits whenever applicable and
then push the new changes to your pull request branch.
1. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
1. Once the pull request is approved, one of the maintainers will merge it.

## Request for Comments

If you just want to receive feedback for a contribution proposal, open an “RFC”
(“Request for Comments”) pull request:

1. On your fork of
[Skills GameOn SDK for Node.js](https://github.com/alexa-games/skills-gameon-sdk-js), create a
branch for the contribution you want feedback on. Use a meaningful name.
1. Create your proposal based on the existing codebase.
1. [Create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)
against the develop branch of the Skills GameOn SDK for Node.js repository. Prefix your pull
request name with `[RFC]`.
1. Discuss your proposal with the community on the pull request page (or on any
other channel). Add the conclusion(s) of this discussion to the pull request
page.

## Contribution Quality Standards

Most quality and style standards are enforced automatically during integration
testing. Your contribution needs to meet the following standards:

* Separate each **logical change** into its own commit.
* Each commit must pass all unit & code style tests, and the full pull request
must pass all integration tests. See https://github.com/alexa-games/skills-gameon-sdk-js for more information on style and tests.
* Unit test coverage must _increase_ the overall project code coverage.
* Include integration tests for any new functionality in your pull request.
* Document all your public functions.
* Commits in your forked repository may be brief or absent.
* Document your pull requests. Include the reasoning behind each change, and
the testing done. Following [commit message best practices](https://github.com/erlang/otp/wiki/writing-good-commit-messages) is recommend.
Your pull request will be squashed into a single commit if it is approved.
* Acknowledge Skills GameOn SDK for Node.js is provisionally licensed as
"Restricted Program Materials" under the Program Materials License Agreement(LICENSE) and certify that no
part of your contribution contravenes this license by signing off on all your
commits with `git -s`. Ensure that every file in your pull request has a
header referring to the repository license file.

## Finding Contributions to Work On

Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/alexa-games/skills-gameon-sdk-js/labels/help%20wanted) issues is a great place to start.

## Code of Conduct

This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md).

## Security Issue Notifications

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.

## Licensing

See the [LICENSE](https://github.com/alexa-games/skills-gameon-sdk-js/blob/master/LICENSE) file for our project's licensing and the [NOTICE](https://github.com/alexa-games/skills-gameon-sdk-js/blob/master/NOTICE) for anything that differs or related notices. We will ask you to confirm the licensing of your contribution.

We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
10 changes: 10 additions & 0 deletions CREDITS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Skills GameOn SDK for Node.js Credits and Thanks
(This file is autogenerated using [update-credits.sh](tools/update-credits.sh).)

The Skills GameOn SDK for Node.js provides easy access to Amazon GameOn and creates higher-level methods, utilities, and examples that simplify the integration of GameOn features, like leaderboards, with Alexa skills.

Contributors to the Skills GameOn SDK for Node.js repository:

* Alexa Games <[email protected]>
* Daniel Wang <[email protected]>
* Dylan House <[email protected]>
Loading

0 comments on commit 29ab62e

Please sign in to comment.