feat(blueprint): use node-package-blueprint scripts, deps, and structure

Author: Rendez

.eslintrc

@@ -1,15 +1,12 @@
 {
-  "env": {
-    "browser": true
-  },
-  "extends": "airbnb-base",
+  "extends": ["@researchgate/rg-base", "@researchgate/rg-react"],
   "parser": "babel-eslint",
   "rules": {
-    "no-underscore-dangle": 0,
-    "arrow-parens": 0,
-    "comma-dangle": 0,
-    "no-unused-vars": 0,
-    "react/jsx-uses-react": 0,
-    "import/no-extraneous-dependencies": ["error", { "devDependencies": true }]
+    "import/no-extraneous-dependencies": [
+      "error",
+      {
+        "devDependencies": true
+      }
+    ]
   }
 }

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,47 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open, inclusive, and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, nationality, personal appearance, race, religion, sexual identity and orientation, level of experience, or technical ability.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of different viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Sustained disruption of discussion
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+The ResearchGate community prioritizes (marginalized) people's safety over (privileged) people's comfort.
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instance of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [researchgate@github.com](mailto:researchgate@github.com). All complaints will be reviewed and investigated, and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regards to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is based on [Contributor Covenant][homepage].
+
+[homepage]: http://contributor-covenant.org

.github/CONTRIBUTING.md

@@ -1,90 +1,135 @@
-# Contributing
+# Contributing Guide
 
-When contributing to this repository, please first discuss the change you wish to make via issue,
-email, or any other method with the owners of this repository before making a change. 
+Thanks for taking the time to contribute!
 
-Please note we have a code of conduct, please follow it in all your interactions with the project.
+### Table of contents
 
-## Pull Request Process
+[Code of Conduct](#code-of-conduct)
 
-1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
-   build.
-2. Update the README.md with details of changes to the interface, this includes new environment 
-   variables, exposed ports, useful file locations and container parameters.
-3. Increase the version numbers in any examples files and the README.md to the new version that this
-   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+[Contribution prerequisites](#contribution-prerequisites)
+
+[Project Setup](#project-setup)
+  * [How to run the project](#how-to-run-the-project)
+  * [How to run tests](#how-to-run-tests)
+
+[How can you contribute](#how-can-you-contribute)
+  * [Reporting bugs](#reporting-bugs)
+  * [Suggesting enhancements](#suggesting-enhancements)
+  * [Writing documentation](#writing-documentation)
+  * [Your first code contribution](#your-first-code-contribution)
+
+[Additional Notes](#additional-notes)
+  * [Issue and Pull Request Templates](#issue-and-pull-request-templates)
+  * [Need help?](#need-help?)
 
 ## Code of Conduct
 
-### Our Pledge
+This project and everyone contributing to it adheres to the [ResearchGate Code of Conduct](CODE_OF_CONDUCT.md).
+By participating you are expected to uphold this code. Please report any behavior you find unacceptable to [researchgate@github.com](mailto:researchgate@github.com).
+
+## Contribution prerequisites
+
+Before you start your work, make sure that you:
+
+* have `node` installed at v6.10.0
+* have `npm` installed at 5.3.0
+* have `yarn` installed at v0.21.3
+* are familiar with `git`
+* are familiar with [conventional commits](http://conventionalcommits.org)
+* have read and agree to abide by the [ResearchGate Code of Conduct](CODE_OF_CONDUCT.md)
+
+## Project setup
+
+### How to run the project
+
+Create a clone of the repository:
+
+```
+git clone https://github.com/researchgate/react-intersection-observer.git
+cd react-intersection-observer
+```
+
+Install the dependencies with:
+
+```
+npm install
+```
+
+Now run storybook:
+
+```
+npm run storybook
+```
+
+### How to run tests
+
+This project uses [jest](http://facebook.github.io/jest/) for JavaScript testing.
+
+To run tests, execute:
+
+```
+yarn test
+```
+
+Since coverage is not collected by default when running yarn test, run:
+
+```
+yarn coverage
+```
+
+To run linters use:
+
+```
+yarn lint
+```
+
+## How you can contribute
+
+### Reporting bugs
+
+This section guides you through the steps to follow when you submit a bug report for a ResearchGate project.
+
+Following these guidelines makes it easy for the maintainers and community to understand your report, reproduce the behavior, and find related reports.
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
+Before creating a bug report, please check Open Issues as you may find that there is already an issue open for the bug you’ve found. When you create a bug report, be sure to include as much detail as possible and fill out [the required template](ISSUE_TEMPLATE.md), the information it asks for helps us resolve issues faster.
 
-### Our Standards
+After you have submitted the issue, we'll try to get back to you as soon as possible.
 
-Examples of behavior that contributes to creating a positive environment
-include:
+### Suggesting enhancements
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+This section guides you through submitting a feature suggestion.
 
-Examples of unacceptable behavior by participants include:
+All enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/) and, when approved by a core team member or project maintainer, are given the green light to then be turned into a Pull Request.
+For the best possible experience, please provide us with:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
+* **A clear and descriptive title**
+* **A step-by-step description of the suggested enhancement** and what it should do
+* **Specific examples to demonstrate the steps**. Ideally, you should support it with code snippets, screenshots, and/or animated GIFs
+* **Explanation of why this feature would be useful** to this project
+* **Your development environment** and context for creating the feature
 
-### Our Responsibilities
+After you have submitted your Pull Request, we'll try to get back to you as soon as possible.
 
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+### Writing documentation
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+All great projects require good documentation.
+There is __always__ room for (better) docs, so why not to contribute to the project by enhancing them?
+Please do so via Pull Request.
 
-### Scope
+### Your first code contribution
 
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
+Unsure where you can start contributing?
+We strive to make all our projects easy for beginners to contribute to. Just look out for issues labeled `help-wanted` and `beginner-friendly`, then get stuck in!
+If you still need some guidance, consider [this resource](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github) and/or contact us.
 
-### Enforcement
+## Additional notes
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at mail@luismerino.name. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+### Issue and pull request templates
 
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
+When filing an issue or pull request, please take the time to fill out the templates we provide in as much detail as you can. This helps ensure that we have all the information we need to provide you with the right support so that your experience contributing to our open-source project runs as smoothly and easily as you would like it to.
 
-### Attribution
+### Need help?
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+If you need any help or require additional information, don't hesitate to contact the project maintainer or any of the contributors.
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+Thank you for contributing!

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,27 @@
+Thanks for taking the time to file an issue with us.
+Please note that this issue template is used **ONLY** for reporting bugs.
+
+If you have an issue that isn’t a bug, please follow the steps listed in the [Contributing](CONTRIBUTING.md).
+Thanks!
+
+## Expected behavior
+<!--- What should happen -->
+
+## Current behavior
+<!--- What is happening instead of the expected behavior -->
+
+## Steps to reproduce
+<!--- Provide a link to a live example, a code snippet, or a set of steps to -->
+<!--- reproduce this bug. -->
+1.
+2.
+3.
+4.
+
+## Context (environment)
+<!--- Please provide technical context, as well as possible background -->
+<!--- information that can help us identify the problem -->
+
+* **Version**: <!-- compulsory. you must provide your version -->
+* **Platform**: <!-- either `uname -a` output, or if Windows, version and 32-bit or
+  64-bit -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,34 @@
+Thanks for taking the time to file a pull request with us.
+Please take a moment to provide the following details:
+
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Description
+<!--- Describe your changes in detail -->
+
+## Motivation and context
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## How has this been tested?
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+
+## Screenshots (if relevant):
+
+## Type of change
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Checklist:
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] My code follows the code style of this project
+- [ ] My change requires a change to the documentation
+- [ ] I have updated the documentation accordingly
+- [ ] I have read the [CONTRIBUTING](CONTRIBUTING.md) document
+- [ ] I have added tests to cover my changes
+- [ ] All new and existing tests passed

.gitignore

@@ -3,5 +3,8 @@
 node_modules
 npm-debug.log*
 lib
-docs
-coverage
+coverage
+docs/static
+docs/favicon*
+docs/*.html
+flow-typed

.npmignore

@@ -17,7 +17,7 @@ npm-debug.log
 .tmp
 .eslintignore
 yarn.lock
-examples
 .storybook
-test
-example
+docs/static
+docs/favicon
+docs/*.html

.storybook/config.js

@@ -7,4 +7,4 @@ setOptions({
   downPanelInRight: true,
 });
 
-storybook.configure(() => require('../examples/index.js'), module);
+storybook.configure(() => require('../docs/docs/index.js'), module);