Merge 73e91eb into de462b3

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,9 @@
+**Do you want to request a *feature* or report a *bug*?**
+
+**What is the current behavior?**
+
+**If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem. Your bug will get fixed much faster if we can run your code and it doesn't have dependencies other than React. Paste the link to your CodeSandbox (https://codesandbox.io/s/new) example below:**
+
+**What is the expected behavior?**
+
+**Which versions of React, and which browser / OS are affected by this issue? Did this work in previous versions of React?**

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+**Before submitting a pull request,** please make sure the following is done:
+
+1. Fork [the repository](https://github.com/fkhadra/react-toastify) and create your branch from `master`.
+2. Run `yarn` in the repository root.
+3. If you've fixed a bug or added code that should be tested, add tests!
+4. Ensure the test suite passes (`yarn test`).
+5. Run `yarn start` to test your changes in the playground.
+6. Update the readme is needed
+7. Update the typescript definition is needed
+8. Format your code with [prettier](https://github.com/prettier/prettier) (`yarn prettier-all`).
+9. Make sure your code lints (`yarn lint:fix`).
+
+**Learn more about contributing [here](https://github.com/fkhadra/react-toastify/blob/master/CONTRIBUTING.md)** 

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* 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
+
+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
+* 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
+
+## 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 instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at fdkhadra@gmail.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 regard 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 adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# Contributing 
+
+:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
+
+When contributing to this repository, please first discuss the change you wish to make via issue before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## General Guidelines
+
+- If adding a new feature, write the corresponding test
+- Ensure that nothing get broke. You can use the playground for that
+- If applicable, pdate the readme
+- If applicable, update the typescript definition
+- Use prettier before commiting 😭
+- When solving a bug, please provide the steps to reproduce it(codesandbox is our best friend for that)
+- Tchill 👌
+
+## Setup
+
+### Pre-requisites
+
+- *Node:* `^9.0.0`
+- *Yarn or Npm*
+
+### Install
+
+Clone the repository and create a local branch:
+
+```sh
+git clone https://github.com/fkhadra/react-toastify.git
+cd react-toastify
+
+git checkout -b my-branch
+```
+
+Install dependencies:
+
+```sh
+yarn install
+```
+
+## Developing
+
+How it works ? The library don't use a state management library like redux or mobx to dispatch the notifications. Instead it uses a dead simple pubsub.
+
+
+```sh
+# launch the playground
+yarn start
+
+# Run tests 💩
+yarn test
+
+# Prettify all the things
+yarn prettier-all
+```
+
+### Project structure
+
+#### Scss
+
+All the style rules lives in the `scss` directory. The filename are self-explanatory about their content. 
+
+#### Playground
+
+The playground let you test your changes, it's like the demo of react-toastify. Most of the time you don't need to modify it unless you add new features.
+
+#### Src
+
+- [toast:](https://github.com/fkhadra/react-toastify/blob/master/src/toast.js) Contain the exposed api (`toast.success...`).
+
+- [ToastContainer:](https://github.com/fkhadra/react-toastify/blob/master/src/components/ToastContainer.js) 
+This is the presentation layer. His responsibility is to display the notifications.
+
+- [eventManager:](https://github.com/fkhadra/react-toastify/blob/master/src/utils/eventManager.js) 
+This is the glue between `toast` and `ToastContainer`. In fact, it is just a dead simple pubsub.
+
+## License
+By contributing, you agree that your contributions will be licensed under its MIT License.