From ef5fec6b5a34fd78cb169a606d618131ce161902 Mon Sep 17 00:00:00 2001 From: Pedro Nauck Date: Thu, 21 Jun 2018 03:32:57 -0300 Subject: [PATCH] chore: add contributing and contributors --- .all-contributorsrc | 56 +++++++++++++++++ CONTRIBUTING.md | 94 +++++++++++++++++++++++++++++ README.md | 15 ++++- package.json | 18 +++++- yarn.lock | 142 +++++++++++++++++++++++++++++++++++++++++--- 5 files changed, 313 insertions(+), 12 deletions(-) create mode 100644 .all-contributorsrc create mode 100644 CONTRIBUTING.md diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 000000000..4c691e66e --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,56 @@ +{ + "projectName": "docz", + "projectOwner": "pedronauck", + "repoType": "github", + "repoHost": "https://github.com", + "files": [ + "README.md", + "CONTRIBUTING.md" + ], + "imageSize": 60, + "commit": true, + "contributors": [ + { + "login": "renatorib", + "name": "Renato Ribeiro", + "avatar_url": "https://avatars2.githubusercontent.com/u/3277185?v=4", + "profile": "http://twitter.com/renatorib_", + "contributions": [ + "code", + "doc", + "bug", + "ideas", + "plugin", + "tool" + ] + }, + { + "login": "Swapnull", + "name": "Martyn Rushton", + "avatar_url": "https://avatars0.githubusercontent.com/u/4456346?v=4", + "profile": "http://swapnull.co.uk", + "contributions": [ + "code" + ] + }, + { + "login": "marceloavf", + "name": "Marcelo FormentΓ£o", + "avatar_url": "https://avatars3.githubusercontent.com/u/5435657?v=4", + "profile": "https://github.com/marceloavf", + "contributions": [ + "code", + "bug" + ] + }, + { + "login": "good-idea", + "name": "Joseph Thomas", + "avatar_url": "https://avatars3.githubusercontent.com/u/11514928?v=4", + "profile": "https://www.good-idea.studio", + "contributions": [ + "code" + ] + } + ] +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..3b397104b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,94 @@ +# Contributing + +Contributions, issues and feature requests are very welcome. If you are using this package and fixed a bug for yourself, please consider submitting a PR! Also you can ping me at [Twitter](https://twitter.com/pedronauck) + +## Guidelines + +If you will develop some pull request, it's very important follow these basic rules: + +### Commit messages + +Commit messages should follow the [commit message convention](https://conventionalcommits.org/) so that changelogs can be automatically generated. Commit messages will be automatically validated upon commit. If you are not familiar with the commit message convention, you can use `yarn commit` instead of `git commit`, which provides an interactive CLI for generating proper commit messages. + +### General guidelines + +- The master branch is basically just a snapshot of the latest stable release. All development should be done in dedicated branch. **Do not submit PRs against the master branch.** +- Checkout a topic branch from the relevant branch, e.g. `dev`, and merge back against that branch. +- Work in the **src** folder of respective package and **DO NOT** checkin dist in the commits. +- It's OK - and a very nice thing - to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging. + +### If adding new feature: + +- Make sure that [all examples](https://github.com/pedronauck/docz/tree/master/examples) are running as expected +- Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it. + +## Setup + +### Pre-requisites + +- *Node:* `^9.0.0` +- *Yarn:* `^1.7.0` + +### Install + +Check out the code and go into the docz directory: + +```bash +git clone https://github.com/pedronauck/docz.git +cd docz +``` + +Then run yarn install and bootstrap all packages: + +```bash +$ yarn install +$ yarn bs +``` + +After that, just run `packages` script to format, build and lint all packages: + +```bash +$ yarn packages +``` + +## Developing + +There just few things that you need to know if you want to start to develop on docz + +### Project structure + +There's a lot of packages on [packages](https://github.com/pedronauck/docz/tree/master/packages) folder that are so necessary to docz run, but basically has just two packages that you need to know more about: + +#### **[docz-core](https://github.com/pedronauck/docz/tree/master/packages/docz)** +- This is the core of docz, all build process, server process and parses belongs to here! +- If you break this package, you'll break all packages! Please, be carefull. +- All cli commands are built here and imported on `docz` package on `./bin` script +- Do not create and use not relative to client here, just node scripts! + +#### **[docz](https://github.com/pedronauck/docz/tree/master/packages/docz)** +- Main and top level package. +- It's not have any node script unless the `./bin` script using `docz-core` and `yargs` to build the cli tool. +- Just built-ins components are built in this package +- This package shouldn't have any component style, just logic! + +### Watching projects + +To speed up your develop process, you can split your terminal by open the packages that you need to develop and run `yarn dev` in each window. This will build the package in dev mode. So, after that, you can use any splitted window to run `yarn dev` too in some example package to see it in action, like that: + +![](https://cdn-std.dprcdn.net/files/acc_649651/MdH4FL) + +Above you watching `docz`, `docz-core` and `docz-theme-default` and running `docz-example-basic`. So, any modification that is made on any package will reflect on basic example on the fly! + +### Creating plugins + +If you see that has some plugin that you can create and don't have this plugin on `packages/` folder, please contact-me before to we talk about make this plugin official! + +## Contributors + +Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): + + + +| [
Renato Ribeiro](http://twitter.com/renatorib_)
[πŸ’»](https://github.com/pedronauck/docz/commits?author=renatorib "Code") [πŸ“–](https://github.com/pedronauck/docz/commits?author=renatorib "Documentation") [πŸ›](https://github.com/pedronauck/docz/issues?q=author%3Arenatorib "Bug reports") [πŸ€”](#ideas-renatorib "Ideas, Planning, & Feedback") [πŸ”Œ](#plugin-renatorib "Plugin/utility libraries") [πŸ”§](#tool-renatorib "Tools") | [
Martyn Rushton](http://swapnull.co.uk)
[πŸ’»](https://github.com/pedronauck/docz/commits?author=Swapnull "Code") | [
Marcelo FormentΓ£o](https://github.com/marceloavf)
[πŸ’»](https://github.com/pedronauck/docz/commits?author=marceloavf "Code") [πŸ›](https://github.com/pedronauck/docz/issues?q=author%3Amarceloavf "Bug reports") | [
Joseph Thomas](https://www.good-idea.studio)
[πŸ’»](https://github.com/pedronauck/docz/commits?author=good-idea "Code") | +| :---: | :---: | :---: | :---: | + diff --git a/README.md b/README.md index 1b81d9172..97bc5871e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@

+[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors) @@ -105,5 +106,15 @@ Any doubt? Check [our docs](http://docz.site) to see more about Docz! ## 🀝   Contributions -Contributions, issues and feature requests are very welcome. If you are using this package and fixed a bug for yourself, please consider submitting a PR! -Also you can ping me at [Twitter](https://twitter.com/pedronauck) +Contributions, issues and feature requests are very welcome. +Please make sure to read the [Contributing Guide](/CONTRIBUTING.md) before making a pull request. + +## Contributors + +Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): + + + +| [
Renato Ribeiro](http://twitter.com/renatorib_)
[πŸ’»](https://github.com/pedronauck/docz/commits?author=renatorib "Code") [πŸ“–](https://github.com/pedronauck/docz/commits?author=renatorib "Documentation") [πŸ›](https://github.com/pedronauck/docz/issues?q=author%3Arenatorib "Bug reports") [πŸ€”](#ideas-renatorib "Ideas, Planning, & Feedback") [πŸ”Œ](#plugin-renatorib "Plugin/utility libraries") [πŸ”§](#tool-renatorib "Tools") | [
Martyn Rushton](http://swapnull.co.uk)
[πŸ’»](https://github.com/pedronauck/docz/commits?author=Swapnull "Code") | [
Marcelo FormentΓ£o](https://github.com/marceloavf)
[πŸ’»](https://github.com/pedronauck/docz/commits?author=marceloavf "Code") [πŸ›](https://github.com/pedronauck/docz/issues?q=author%3Amarceloavf "Bug reports") | [
Joseph Thomas](https://www.good-idea.studio)
[πŸ’»](https://github.com/pedronauck/docz/commits?author=good-idea "Code") | +| :---: | :---: | :---: | :---: | + diff --git a/package.json b/package.json index ec8365769..9043fd975 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,19 @@ { "private": true, "license": "MIT", + "author": { + "name": "Pedro Nauck", + "email": "pedronauck@gmail.com", + "url": "https://github.com/pedronauck" + }, + "homepage": "https://docz.site", + "bugs": { + "url": "https://github.com/pedronauck/docz/issues" + }, + "repository":{ + "type" : "git", + "url" : "https://github.com/pedronauck/docz.git" + }, "scripts": { "clean": "lerna clean", "bs": "lerna bootstrap", @@ -12,12 +25,15 @@ "release": "lerna publish --conventional-commits", "release:beta": "yarn release --npm-tag=beta --preid=beta", "precommit": "lint-staged", - "commit": "git-cz" + "commit": "git-cz", + "contributors:add": "all-contributors add", + "contributors:generate": "all-contributors generate" }, "devDependencies": { "@commitlint/cli": "^7.0.0", "@commitlint/config-conventional": "^7.0.1", "@commitlint/config-lerna-scopes": "^7.0.0", + "all-contributors-cli": "^5.2.0", "commitizen": "^2.10.1", "del": "^3.0.0", "husky": "^1.0.0-rc.9", diff --git a/yarn.lock b/yarn.lock index d5d2aa0bd..123f49644 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1611,7 +1611,7 @@ ajv@^4.9.1: co "^4.6.0" json-stable-stringify "^1.0.1" -ajv@^5.2.3, ajv@^5.3.0: +ajv@^5.1.0, ajv@^5.2.3, ajv@^5.3.0: version "5.5.2" resolved "https://registry.npmjs.org/ajv/-/ajv-5.5.2.tgz#73b5eeca3fab653e3d3f9422b341ad42205dc965" dependencies: @@ -1646,6 +1646,18 @@ align-text@^0.1.1, align-text@^0.1.3: longest "^1.0.1" repeat-string "^1.5.2" +all-contributors-cli@^5.2.0: + version "5.2.0" + resolved "https://registry.npmjs.org/all-contributors-cli/-/all-contributors-cli-5.2.0.tgz#469508aee0906047944e3fad5c88f80c681a909a" + dependencies: + async "^2.0.0-rc.1" + chalk "^2.3.0" + inquirer "^4.0.0" + lodash "^4.11.2" + pify "^3.0.0" + request "^2.72.0" + yargs "^10.0.3" + amdefine@>=0.0.4: version "1.0.1" resolved "https://registry.npmjs.org/amdefine/-/amdefine-1.0.1.tgz#4a5282ac164729e93619bcfd3ad151f817ce91f5" @@ -1860,6 +1872,12 @@ async@^1.4.0, async@^1.5.0: version "1.5.2" resolved "https://registry.npmjs.org/async/-/async-1.5.2.tgz#ec6a61ae56480c0c3cb241c95618e20892f9672a" +async@^2.0.0-rc.1: + version "2.6.1" + resolved "https://registry.npmjs.org/async/-/async-2.6.1.tgz#b245a23ca71930044ec53fa46aa00a3e87c6a610" + dependencies: + lodash "^4.17.10" + async@^2.1.4: version "2.6.0" resolved "https://registry.npmjs.org/async/-/async-2.6.0.tgz#61a29abb6fcc026fea77e56d1c6ec53a795951f4" @@ -1878,7 +1896,11 @@ aws-sign2@~0.6.0: version "0.6.0" resolved "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.6.0.tgz#14342dd38dbcc94d0e5b87d763cd63612c0e794f" -aws4@^1.2.1: +aws-sign2@~0.7.0: + version "0.7.0" + resolved "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.7.0.tgz#b46e890934a9591f2d2f6f86d7e6a9f1b3fe76a8" + +aws4@^1.2.1, aws4@^1.6.0: version "1.7.0" resolved "https://registry.npmjs.org/aws4/-/aws4-1.7.0.tgz#d4d0e9b9dbfca77bf08eeb0a8a471550fe39e289" @@ -3251,7 +3273,7 @@ columnify@^1.5.4: strip-ansi "^3.0.0" wcwidth "^1.0.0" -combined-stream@^1.0.5, combined-stream@~1.0.5: +combined-stream@1.0.6, combined-stream@^1.0.5, combined-stream@~1.0.5: version "1.0.6" resolved "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.6.tgz#723e7df6e801ac5613113a7e445a9b69cb632818" dependencies: @@ -4574,7 +4596,7 @@ extend-shallow@^3.0.0, extend-shallow@^3.0.2: assign-symbols "^1.0.0" is-extendable "^1.0.1" -extend@^3.0.0, extend@^3.0.1, extend@~3.0.0: +extend@^3.0.0, extend@^3.0.1, extend@~3.0.0, extend@~3.0.1: version "3.0.1" resolved "https://registry.npmjs.org/extend/-/extend-3.0.1.tgz#a755ea7bc1adfcc5a31ce7e762dbaadc5e636444" @@ -4586,7 +4608,7 @@ external-editor@^1.1.0: spawn-sync "^1.0.15" tmp "^0.0.29" -external-editor@^2.0.1, external-editor@^2.0.4: +external-editor@^2.0.1, external-editor@^2.0.4, external-editor@^2.1.0: version "2.2.0" resolved "https://registry.npmjs.org/external-editor/-/external-editor-2.2.0.tgz#045511cfd8d133f3846673d1047c154e214ad3d5" dependencies: @@ -4867,6 +4889,14 @@ form-data@~2.1.1: combined-stream "^1.0.5" mime-types "^2.1.12" +form-data@~2.3.1: + version "2.3.2" + resolved "https://registry.npmjs.org/form-data/-/form-data-2.3.2.tgz#4970498be604c20c005d4f5c23aecd21d6b49099" + dependencies: + asynckit "^0.4.0" + combined-stream "1.0.6" + mime-types "^2.1.12" + format@^0.2.2: version "0.2.2" resolved "https://registry.npmjs.org/format/-/format-0.2.2.tgz#d6170107e9efdc4ed30c9dc39016df942b5cb58b" @@ -5345,6 +5375,10 @@ har-schema@^1.0.5: version "1.0.5" resolved "https://registry.npmjs.org/har-schema/-/har-schema-1.0.5.tgz#d263135f43307c02c602afc8fe95970c0151369e" +har-schema@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/har-schema/-/har-schema-2.0.0.tgz#a94c2224ebcac04782a0d9035521f24735b7ec92" + har-validator@~4.2.1: version "4.2.1" resolved "https://registry.npmjs.org/har-validator/-/har-validator-4.2.1.tgz#33481d0f1bbff600dd203d75812a6a5fba002e2a" @@ -5352,6 +5386,13 @@ har-validator@~4.2.1: ajv "^4.9.1" har-schema "^1.0.5" +har-validator@~5.0.3: + version "5.0.3" + resolved "https://registry.npmjs.org/har-validator/-/har-validator-5.0.3.tgz#ba402c266194f15956ef15e0fcf242993f6a7dfd" + dependencies: + ajv "^5.1.0" + har-schema "^2.0.0" + has-ansi@^2.0.0: version "2.0.0" resolved "https://registry.npmjs.org/has-ansi/-/has-ansi-2.0.0.tgz#34f5049ce1ecdf2b0649af3ef24e45ed35416d91" @@ -5571,6 +5612,14 @@ http-signature@~1.1.0: jsprim "^1.2.2" sshpk "^1.7.0" +http-signature@~1.2.0: + version "1.2.0" + resolved "https://registry.npmjs.org/http-signature/-/http-signature-1.2.0.tgz#9aecd925114772f3d95b65a60abb8f7c18fbace1" + dependencies: + assert-plus "^1.0.0" + jsprim "^1.2.2" + sshpk "^1.7.0" + https-browserify@^1.0.0: version "1.0.0" resolved "https://registry.npmjs.org/https-browserify/-/https-browserify-1.0.0.tgz#ec06c10e0a34c0f2faf199f7fd7fc78fffd03c73" @@ -5733,6 +5782,25 @@ inquirer@3.3.0, inquirer@^3.0.6, inquirer@^3.2.2: strip-ansi "^4.0.0" through "^2.3.6" +inquirer@^4.0.0: + version "4.0.2" + resolved "https://registry.npmjs.org/inquirer/-/inquirer-4.0.2.tgz#cc678b4cbc0e183a3500cc63395831ec956ab0a3" + dependencies: + ansi-escapes "^3.0.0" + chalk "^2.0.0" + cli-cursor "^2.1.0" + cli-width "^2.0.0" + external-editor "^2.1.0" + figures "^2.0.0" + lodash "^4.3.0" + mute-stream "0.0.7" + run-async "^2.2.0" + rx-lite "^4.0.8" + rx-lite-aggregates "^4.0.8" + string-width "^2.1.0" + strip-ansi "^4.0.0" + through "^2.3.6" + interpret@^1.0.0: version "1.1.0" resolved "https://registry.npmjs.org/interpret/-/interpret-1.1.0.tgz#7ed1b1410c6a0e0f78cf95d3b8440c63f78b8614" @@ -6777,7 +6845,7 @@ lodash@4.17.5, lodash@^4.17.4, lodash@^4.2.1, lodash@^4.3.0: version "4.17.5" resolved "https://registry.npmjs.org/lodash/-/lodash-4.17.5.tgz#99a92d65c0272debe8c96b6057bc8fbfa3bed511" -"lodash@>=3.5 <5", lodash@^4.14.0, lodash@^4.17.10, lodash@^4.17.3, lodash@^4.17.5, lodash@^4.2.0: +"lodash@>=3.5 <5", lodash@^4.11.2, lodash@^4.14.0, lodash@^4.17.10, lodash@^4.17.3, lodash@^4.17.5, lodash@^4.2.0: version "4.17.10" resolved "https://registry.npmjs.org/lodash/-/lodash-4.17.10.tgz#1b7793cf7259ea38fb3661d4d38b3260af8ae4e7" @@ -7091,7 +7159,7 @@ mime-db@~1.33.0: version "1.33.0" resolved "https://registry.npmjs.org/mime-db/-/mime-db-1.33.0.tgz#a3492050a5cb9b63450541e39d9788d2272783db" -mime-types@^2.0.7, mime-types@^2.1.12, mime-types@~2.1.18, mime-types@~2.1.7: +mime-types@^2.0.7, mime-types@^2.1.12, mime-types@~2.1.17, mime-types@~2.1.18, mime-types@~2.1.7: version "2.1.18" resolved "https://registry.npmjs.org/mime-types/-/mime-types-2.1.18.tgz#6f323f60a83d11146f831ff11fd66e2fe5503bb8" dependencies: @@ -7558,7 +7626,7 @@ number-is-nan@^1.0.0: version "1.0.1" resolved "https://registry.npmjs.org/number-is-nan/-/number-is-nan-1.0.1.tgz#097b602b53422a522c1afb8790318336941a011d" -oauth-sign@~0.8.1: +oauth-sign@~0.8.1, oauth-sign@~0.8.2: version "0.8.2" resolved "https://registry.npmjs.org/oauth-sign/-/oauth-sign-0.8.2.tgz#46a6ab7f0aead8deae9ec0565780b7d4efeb9d43" @@ -7995,6 +8063,10 @@ performance-now@^0.2.0: version "0.2.0" resolved "https://registry.npmjs.org/performance-now/-/performance-now-0.2.0.tgz#33ef30c5c77d4ea21c5a53869d91b56d8f2555e5" +performance-now@^2.1.0: + version "2.1.0" + resolved "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz#6309f4e0e5fa913ec1c69307ae364b4b377c9e7b" + pify@^2.0.0, pify@^2.2.0, pify@^2.3.0: version "2.3.0" resolved "https://registry.npmjs.org/pify/-/pify-2.3.0.tgz#ed141a6ac043a849ea588498e7dca8b15330e90c" @@ -8202,6 +8274,10 @@ qs@~6.4.0: version "6.4.0" resolved "https://registry.npmjs.org/qs/-/qs-6.4.0.tgz#13e26d28ad6b0ffaa91312cd3bf708ed351e7233" +qs@~6.5.1: + version "6.5.2" + resolved "https://registry.npmjs.org/qs/-/qs-6.5.2.tgz#cb3ae806e8740444584ef154ce8ee98d403f3e36" + querystring-es3@^0.2.0: version "0.2.1" resolved "https://registry.npmjs.org/querystring-es3/-/querystring-es3-0.2.1.tgz#9ec61f79049875707d69414596fd907a4d711e73" @@ -8833,6 +8909,31 @@ request@2.81.0: tunnel-agent "^0.6.0" uuid "^3.0.0" +request@^2.72.0: + version "2.87.0" + resolved "https://registry.npmjs.org/request/-/request-2.87.0.tgz#32f00235cd08d482b4d0d68db93a829c0ed5756e" + dependencies: + aws-sign2 "~0.7.0" + aws4 "^1.6.0" + caseless "~0.12.0" + combined-stream "~1.0.5" + extend "~3.0.1" + forever-agent "~0.6.1" + form-data "~2.3.1" + har-validator "~5.0.3" + http-signature "~1.2.0" + is-typedarray "~1.0.0" + isstream "~0.1.2" + json-stringify-safe "~5.0.1" + mime-types "~2.1.17" + oauth-sign "~0.8.2" + performance-now "^2.1.0" + qs "~6.5.1" + safe-buffer "^5.1.1" + tough-cookie "~2.3.3" + tunnel-agent "^0.6.0" + uuid "^3.1.0" + require-directory@^2.1.1: version "2.1.1" resolved "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz#8c64ad5fd30dab1c976e2344ffe7f792a6a6df42" @@ -9886,7 +9987,7 @@ touch@^1.0.0: dependencies: nopt "~1.0.10" -tough-cookie@~2.3.0: +tough-cookie@~2.3.0, tough-cookie@~2.3.3: version "2.3.4" resolved "https://registry.npmjs.org/tough-cookie/-/tough-cookie-2.3.4.tgz#ec60cee38ac675063ffc97a5c18970578ee83655" dependencies: @@ -10891,12 +10992,35 @@ yargs-parser@^7.0.0: dependencies: camelcase "^4.1.0" +yargs-parser@^8.1.0: + version "8.1.0" + resolved "https://registry.npmjs.org/yargs-parser/-/yargs-parser-8.1.0.tgz#f1376a33b6629a5d063782944da732631e966950" + dependencies: + camelcase "^4.1.0" + yargs-parser@^9.0.2: version "9.0.2" resolved "https://registry.npmjs.org/yargs-parser/-/yargs-parser-9.0.2.tgz#9ccf6a43460fe4ed40a9bb68f48d43b8a68cc077" dependencies: camelcase "^4.1.0" +yargs@^10.0.3: + version "10.1.2" + resolved "https://registry.npmjs.org/yargs/-/yargs-10.1.2.tgz#454d074c2b16a51a43e2fb7807e4f9de69ccb5c5" + dependencies: + cliui "^4.0.0" + decamelize "^1.1.1" + find-up "^2.1.0" + get-caller-file "^1.0.1" + os-locale "^2.0.0" + require-directory "^2.1.1" + require-main-filename "^1.0.1" + set-blocking "^2.0.0" + string-width "^2.0.0" + which-module "^2.0.0" + y18n "^3.2.1" + yargs-parser "^8.1.0" + yargs@^11.0.0: version "11.0.0" resolved "https://registry.npmjs.org/yargs/-/yargs-11.0.0.tgz#c052931006c5eee74610e5fc0354bedfd08a201b"