diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..be4df7c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,64 @@ +# :eight_spoked_asterisk: :stars: :sparkles: :dizzy: :star2: :star2: :sparkles: :dizzy: :star2: :star2: Contributing :star: :star2: :dizzy: :sparkles: :star: :star2: :dizzy: :sparkles: :stars: :eight_spoked_asterisk: + +So, you want to contribute to this project! That's awesome. However, before +doing so, please read the following simple steps how to contribute. This will +make the life easier and will avoid wasting time on things which are not +requested. :sparkles: + +## Discuss the changes before doing them + - First of all, open an issue in the repository, using the [bug tracker][1], + describing the contribution you would like to make, the bug you found or any + other ideas you have. This will help us to get you started on the right + foot. + + - If it makes sense, add the platform and software information (e.g. operating + system, Node.JS version etc.), screenshots (so we can see what you are + seeing). + + - It is recommended to wait for feedback before continuing to next steps. + However, if the issue is clear (e.g. a typo) and the fix is simple, you can + continue and fix it. + +## Fixing issues + - Fork the project in your account and create a branch with your fix: + `some-great-feature` or `some-issue-fix`. + + - Commit your changes in that branch, writing the code following the + [code style][2]. If the project contains tests (generally, the `test` + directory), you are encouraged to add a test as well. :memo: + + - If the project contains a `package.json` or a `bower.json` file add yourself + in the `contributors` array (or `authors` in the case of `bower.json`; + if the array does not exist, create it): + + ```json + { + "contributors": [ + "Your Name (http://your.website)" + ] + } + ``` + +## Creating a pull request + + - Open a pull request, and reference the initial issue in the pull request + message (e.g. *fixes #*). Write a good description and + title, so everybody will know what is fixed/improved. + + - If it makes sense, add screenshots, gifs etc., so it is easier to see what + is going on. + +## Wait for feedback +Before accepting your contributions, we will review them. You may get feedback +about what should be fixed in your modified code. If so, just keep committing +in your branch and the pull request will be updated automatically. + +## Everyone is happy! +Finally, your contributions will be merged, and everyone will be happy! :smile: +Contributions are more than welcome! + +Thanks! :sweat_smile: + +[1]: https://github.com/jillix/flow-packages/issues + +[2]: https://github.com/IonicaBizau/code-style \ No newline at end of file diff --git a/README.md b/README.md index b87c140..c76046a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,41 @@ -# flow-package [![Version](https://img.shields.io/npm/v/flow-package.svg)](https://www.npmjs.com/package/flow-package) [![Downloads](https://img.shields.io/npm/dt/flow-package.svg)](https://www.npmjs.com/package/flow-package) +# flow-packages [![Version](https://img.shields.io/npm/v/flow-packages.svg)](https://www.npmjs.com/package/flow-packages) [![Downloads](https://img.shields.io/npm/dt/flow-packages.svg)](https://www.npmjs.com/package/flow-packages) > :package: A collection of flow compatible npm packages. +## Example + +```js +const packages = require("flow-packages"); + +console.log(packages); +// [ { name: 'flow-app', +// version: '0.1.0-beta', +// private: true, +// author: { name: 'jillix', email: 'contact@jillix.com' }, +// ... +// _id: 'flow-app@0.1.0-beta' }, +// { name: 'flow-pack', +// version: '0.0.1', +// description: 'Bundle npm modules of a flow app.', +// main: 'index.js', +// bin: { 'flow-pack': 'bin/index.js' }, +// scripts: { test: 'echo "Error: no test specified" && exit 1' }, +// ... +// _id: 'flow-pack@0.0.1' }, +// { name: 'view', +// version: '0.1.0', +// description: 'Render HTML templates', +// repository: { type: 'git', url: 'git://github.com/adioo/view.git' }, +// ... +// _id: 'view@0.1.0' }, +// ... +// { name: 'engine-data-alter', +// version: '1.0.0', +// description: 'Alter engine data', +// ... +// _id: 'engine-data-alter@1.0.0' } ] +``` + ## How to contribute Have an idea? Found a bug? See [how to contribute][contributing]. diff --git a/example/index.js b/example/index.js new file mode 100644 index 0000000..a347efb --- /dev/null +++ b/example/index.js @@ -0,0 +1,29 @@ +const packages = require("../lib"); + +console.log(packages); +// [ { name: 'flow-app', +// version: '0.1.0-beta', +// private: true, +// author: { name: 'jillix', email: 'contact@jillix.com' }, +// ... +// _id: 'flow-app@0.1.0-beta' }, +// { name: 'flow-pack', +// version: '0.0.1', +// description: 'Bundle npm modules of a flow app.', +// main: 'index.js', +// bin: { 'flow-pack': 'bin/index.js' }, +// scripts: { test: 'echo "Error: no test specified" && exit 1' }, +// ... +// _id: 'flow-pack@0.0.1' }, +// { name: 'view', +// version: '0.1.0', +// description: 'Render HTML templates', +// repository: { type: 'git', url: 'git://github.com/adioo/view.git' }, +// ... +// _id: 'view@0.1.0' }, +// ... +// { name: 'engine-data-alter', +// version: '1.0.0', +// description: 'Alter engine data', +// ... +// _id: 'engine-data-alter@1.0.0' } ]