From b073dd3acedb6e4d19f57c10bec850954e104ab1 Mon Sep 17 00:00:00 2001 From: jess Date: Sun, 11 Feb 2018 16:04:31 +0900 Subject: [PATCH] chore: Activating Open Collective (#367) * Added .github/ISSUE_TEMPLATE.md (optional) * Added CONTRIBUTING.md (optional) * Added backers and sponsors on the README * Added call to donate after npm install (optional) * Update README.md --- .github/ISSUE_TEMPLATE.md | 2 ++ CONTRIBUTING.md | 67 +++++++++++++++++++++++++++++++++++++++ README.md | 16 +++++++--- package.json | 13 ++++++-- 4 files changed, 91 insertions(+), 7 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..0bd565e --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,2 @@ + \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..77d2ce7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,67 @@ +# Contribute + +## Introduction + +First, thank you for considering contributing to docsify! 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/docsify). + +## 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/docsify). +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@docsify.opencollective.com. + +## Credits + +### Contributors + +Thank you to all the people who have already contributed to docsify! + + + +### Backers + +Thank you to all our backers! [[Become a backer](https://opencollective.com/docsify#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/docsify#sponsor)) + + + + + + + + + + + + + \ No newline at end of file diff --git a/README.md b/README.md index 79124e1..e2804f5 100644 --- a/README.md +++ b/README.md @@ -9,17 +9,19 @@

+ Backers on Open Collective + Sponsors on Open Collective Travis Status npm - Chat donate

Glod Sponsor via Open Collective

+

- - - + + +

## Links @@ -92,6 +94,12 @@ Support this project by becoming a sponsor. Your logo will show up here with a l +## Contributors + +This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. + + + ## License MIT diff --git a/package.json b/package.json index 6d7b657..222a01a 100644 --- a/package.json +++ b/package.json @@ -27,11 +27,13 @@ "build:ssr": "node build/build-ssr", "test": "eslint {src,packages} --fix", "pub:next": "RELEASE_TAG=next sh build/release.sh", - "pub": "sh build/release.sh" + "pub": "sh build/release.sh", + "postinstall": "opencollective postinstall" }, "dependencies": { "marked": "^0.3.12", "medium-zoom": "^0.2.0", + "opencollective": "^1.0.3", "prismjs": "^1.6.0", "tinydate": "^1.0.0", "tweezer.js": "^1.4.0" @@ -62,5 +64,10 @@ "documentation", "creator", "generator" - ] -} + ], + "collective": { + "type": "opencollective", + "url": "https://opencollective.com/docsify", + "logo": "https://docsify.js.org/_media/icon.svg" + } +} \ No newline at end of file