From 299c3d99d9a236eab0cfaa33bbfe37a66d4475ad Mon Sep 17 00:00:00 2001 From: Jess Date: Sat, 27 Jan 2018 13:25:42 +0900 Subject: [PATCH 1/4] Added CONTRIBUTING.md (optional) --- CONTRIBUTING.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..ae66a189 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,67 @@ +# Contribute + +## Introduction + +First, thank you for considering contributing to echoes-player! It's people like you that make the open source community such a great community! 😊 + +We welcome any type of contribution, not only code. You can help with +- **QA**: file bug reports, the more details you can give the better (e.g. screenshots with the console open) +- **Marketing**: writing blog posts, howto's, printing stickers, ... +- **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ... +- **Code**: take a look at the [open issues](issues). Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them. +- **Money**: we welcome financial contributions in full transparency on our [open collective](https://opencollective.com/echoes-player). + +## Your First Contribution + +Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github). + +## Submitting code + +Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests. + +## Code review process + +The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge. +It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you? + +## Financial contributions + +We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/echoes-player). +Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed. + +## Questions + +If you have any questions, create an [issue](issue) (protip: do a quick search first to see if someone else didn't ask the same question before!). +You can also reach us at hello@echoes-player.opencollective.com. + +## Credits + +### Contributors + +Thank you to all the people who have already contributed to echoes-player! + + + +### Backers + +Thank you to all our backers! [[Become a backer](https://opencollective.com/echoes-player#backer)] + + + + +### Sponsors + +Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/echoes-player#sponsor)) + + + + + + + + + + + + + \ No newline at end of file From f0887b4807b47223dbd220490837157b21e4c431 Mon Sep 17 00:00:00 2001 From: Jess Date: Sat, 27 Jan 2018 13:25:42 +0900 Subject: [PATCH 2/4] Added .github/ISSUE_TEMPLATE.md (optional) --- .github/ISSUE_TEMPLATE.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..05a422c9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,2 @@ + \ No newline at end of file From 33e3c2e470655cd2b8bebcf7f1d5aeed0a920656 Mon Sep 17 00:00:00 2001 From: Jess Date: Sat, 27 Jan 2018 13:26:44 +0900 Subject: [PATCH 3/4] Added backers and sponsors on the README --- README.md | 34 ++++++++++++++++++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c3b0d3fb..591c67dd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -[![Build Status](https://travis-ci.org/orizens/echoes-player.svg?branch=master)](https://travis-ci.org/orizens/echoes-player) [![Code Climate](https://codeclimate.com/github/orizens/echoes-player/badges/gpa.svg)](https://codeclimate.com/github/orizens/echoes-player) +[![Build Status](https://travis-ci.org/orizens/echoes-player.svg?branch=master)](https://travis-ci.org/orizens/echoes-player) [![Code Climate](https://codeclimate.com/github/orizens/echoes-player/badges/gpa.svg)](https://codeclimate.com/github/orizens/echoes-player) [![Backers on Open Collective](https://opencollective.com/echoes-player/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/echoes-player/sponsors/badge.svg)](#sponsors) + # Echoes Player - Angular Version (2nd Generation) Echoes is a great youtube player developed by [Oren Farhi](http://orizens.com). @@ -91,4 +92,33 @@ To get more help on the Angular CLI use `ng help` or go check out the [Angular C [look at issue](https://github.com/angular/angular-cli/issues/4172) 1. make sure ```npm i source-map-explorer -g``` 1. ```ng build --prod --aot --sm``` (the sourcemap is for later steps) -1. ```cd dist && source-map-explorer A-FILE-WITH-HASH.js``` \ No newline at end of file +1. ```cd dist && source-map-explorer A-FILE-WITH-HASH.js``` +## Contributors + +This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. + + + +## Backers + +Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/echoes-player#backer)] + + + + +## Sponsors + +Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/echoes-player#sponsor)] + + + + + + + + + + + + + From 663b0c1af0cb8cb6681960fd7668bfd1f7a524f6 Mon Sep 17 00:00:00 2001 From: Jess Date: Sat, 27 Jan 2018 13:26:44 +0900 Subject: [PATCH 4/4] Added call to donate after npm install (optional) --- package.json | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index cada5495..f55dee24 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,7 @@ "build": "ng build", "build:prod": "ng build --prod", "build:env": "node config/build-env.js", - "postinstall": "npm rebuild node-sass", + "postinstall": "npm rebuild node-sass && opencollective postinstall", "copy:heroku": "shx cp -r ./config/heroku/*.* ./dist", "copy:domain": "shx cp CNAME ./dist", "copy:package": "shx cp ./package.json ./dist/assets/", @@ -33,6 +33,7 @@ "@angular/router": "^5.0.0", "core-js": "^2.4.1", "http-server": "0.10.0", + "opencollective": "^1.0.3", "replace": "0.3.0", "rxjs": "^5.5.2", "zone.js": "^0.8.14" @@ -76,5 +77,10 @@ "tslint": "~5.7.0", "typescript": "~2.4.2", "uglify-es": "3.2.2" + }, + "collective": { + "type": "opencollective", + "url": "https://opencollective.com/echoes-player", + "logo": "https://opencollective.com/echoes-player/logo.txt" } } \ No newline at end of file