From 6ff78729bed842db3cdd2b02cdd970481082e109 Mon Sep 17 00:00:00 2001 From: asood123 Date: Wed, 27 Sep 2017 11:22:22 -0400 Subject: [PATCH] misc: activating open collective [ci skip] --- .github/ISSUE_TEMPLATE.md | 3 ++ CONTRIBUTING.md | 67 +++++++++++++++++++++++++++++++++++++++ README.md | 34 ++++++++++++++++++-- package.json | 11 +++++-- 4 files changed, 111 insertions(+), 4 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 045546d6..c37b311a 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -5,3 +5,6 @@ ### Steps to reproduce the behavior + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..1076c9bc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,67 @@ +# Contribute + +## Introduction + +First, thank you for considering contributing to Wiki.js! 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/wikijs). + +## 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/wikijs). +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@wikijs.opencollective.com. + +## Credits + +### Contributors + +Thank you to all the people who have already contributed to Wiki.js! + + + +### Backers + +Thank you to all our backers! [[Become a backer](https://opencollective.com/wikijs#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/wikijs#sponsor)) + + + + + + + + + + + + + diff --git a/README.md b/README.md index e26267fe..21e27978 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,16 @@ [![Release](https://img.shields.io/github/release/Requarks/wiki.svg?style=flat-square&maxAge=3600)](https://github.com/Requarks/wiki/releases) [![License](https://img.shields.io/badge/license-AGPLv3-blue.svg?style=flat-square)](https://github.com/requarks/wiki/blob/master/LICENSE) +[![Backers on Open Collective](https://opencollective.com/wikijs/backers/badge.svg)](#backers) +[![Sponsors on Open Collective](https://opencollective.com/wikijs/sponsors/badge.svg)](#sponsors) [![npm](https://img.shields.io/badge/npm-wiki.js-blue.svg?style=flat-square)](https://www.npmjs.com/package/wiki.js) -[![Downloads](https://img.shields.io/github/downloads/Requarks/wiki/total.svg?style=flat-square)](https://www.npmjs.com/package/wiki.js) -[![Twitter Follow](https://img.shields.io/badge/follow-%40requarks-blue.svg?style=flat-square)](https://twitter.com/requarks) +[![Downloads](https://img.shields.io/github/downloads/Requarks/wiki/total.svg?style=flat-square)](https://www.npmjs.com/package/wiki.js) [![Build Status](https://app.wercker.com/status/fc8e75793b3cf12852314d6bfd83d148/s/master?style=flat-square)](https://app.wercker.com/project/byKey/fc8e75793b3cf12852314d6bfd83d148) [![Codacy Badge](https://img.shields.io/codacy/grade/1d0217a3153c4595bdedb322263e55c8/master.svg?style=flat-square)](https://www.codacy.com/app/Requarks/wiki) [![Dependency Status](https://img.shields.io/gemnasium/Requarks/wiki.svg?style=flat-square)](https://gemnasium.com/github.com/Requarks/wiki) [![Standard - JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/) [![Chat on Gitter](https://img.shields.io/badge/chat-on_gitter-CC2B5E.svg?style=flat-square&logo=image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAcAAAAOCAMAAADUg/YpAAAABlBMVEUAAAD///%2Bl2Z/dAAAAAXRSTlMAQObYZgAAABVJREFUeAFjwAUYYTQByAAh0WicAAAFnwAYeB5bLwAAAABJRU5ErkJggg==)](https://gitter.im/Requarks/wiki) +[![Twitter Follow](https://img.shields.io/badge/follow-%40requarks-blue.svg?style=flat-square)](https://twitter.com/requarks) ##### A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown @@ -143,3 +145,31 @@ We are looking for translators to make Wiki.js available in multiple languages. ![DigitalOcean](https://wiki.js.org/assets/images/logo_digitalocean.png) [DigitalOcean](https://www.digitalocean.com/) for providing hosting of the Wiki.js documentation site. + +## 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/wikijs#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/wikijs#sponsor)] + + + + + + + + + + + + + diff --git a/package.json b/package.json index 2f5a6f87..d553c9d2 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,8 @@ "build": "node tools/fuse", "dev": "node tools/fuse -d", "dev-configure": "node tools/fuse -c", - "test": "jest" + "test": "jest", + "postinstall": "opencollective postinstall" }, "bin": { "wiki": "wiki.js" @@ -93,6 +94,7 @@ "multer": "~1.3.0", "node-2fa": "~1.1.2", "node-graceful": "~0.2.3", + "opencollective": "~1.0.3", "ora": "~1.3.0", "passport": "~0.4.0", "passport-azure-ad-oauth2": "0.0.4", @@ -172,5 +174,10 @@ "**/?(*.)(spec|test).js?(x)" ], "verbose": true + }, + "collective": { + "type": "opencollective", + "url": "https://opencollective.com/wikijs", + "logo": "https://opencollective.com/opencollective/logo.txt" } -} +} \ No newline at end of file