Merge pull request #73 from marmelab/feat/github-pimp

feat(github): improve github community standards

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# 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, gender identity and expression, level of experience, 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 [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems 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://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing
+
+So you want to contribute to atomic-crm? Awesome! Thank you in advance for your contribution. Here are a few guidelines that will help you along the way.
+
+
+## Opening an Issue
+
+If you think you have found a bug, or have a new feature idea, please start by making sure it hasn't already been [reported or fixed](https://github.com/marmelab/atomic-crm/issues?q=is%3Aissue+is%3Aclosed). You can search through existing issues and PRs to see if someone has reported one similar to yours.
+
+Next, create a new issue that briefly explains the problem, and provides a bit of background as to the circumstances that triggered it, and steps to reproduce it.
+
+For code issues please include:
+* atomic-crm version (package.json)
+* React version
+* Browser version
+
+For visual or layout problems, images or animated gifs can help explain your issue.
+It's even better with a live reproduction test case.
+
+### Issue Guidelines
+
+Please use a succinct description. "doesn't work" doesn't help others find similar issues.
+
+Please don't group multiple topics into one issue, but instead each should be its own issue.
+
+And please don't just '+1' an issue. It spams the maintainers and doesn't help move the issue forward.
+
+## Submitting a Pull Request
+
+atomic-crm is a community project, so pull requests are always welcome, but before working on a large change, it is best to open an issue first to discuss it with the maintainers. In that case, prefix it with "[RFC]" (Request for Comments)
+
+When in doubt, keep your pull requests small. To give a PR the best chance of getting accepted, don't bundle more than one feature or bug fix per pull request. It's always best to create two smaller PRs than one big one.
+
+The core team prefix their PRs width "[WIP]" (Work in Progress) or "[RFR]" (ready for Review), don't hesitate to do the same to explain how far you are from completion.
+
+When adding new features or modifying existing, please attempt to include tests to confirm the new behaviour.
+
+### Coding style
+
+You must follow the coding style of the existing files. atomic-crm uses eslint and [prettier](https://github.com/prettier/prettier). You can reformat all the project files automatically by calling
+
+```sh
+make lint
+```
+
+**Tip**: If possible, enable linting in your editor to get realtime feedback and/or fixes.
+
+## License
+
+By contributing your code to the marmelab/atomic-crm GitHub repository, you agree to license your contribution under the MIT license.

.github/ISSUE_TEMPLATE/Bug_report.md

@@ -0,0 +1,35 @@
+---
+name: "\U0001F41B Bug report"
+about: Something isn't working as expected. Please tell us!
+
+---
+
+**What you were expecting:**
+<!-- Describe what the behavior would be without the bug. -->
+
+**What happened instead:**
+<!-- Describe how the bug manifests. -->
+
+**Steps to reproduce:**
+<!--  Please explain the steps required to duplicate the issue, especially if you are able to provide a sample application. -->
+
+**Related code:**
+<!-- If you are able to illustrate the bug or feature request with an example, please provide a sample application via one of the following means: -->
+
+* A link to a GitHub repo with the minimal codebase to reproduce the issue
+
+
+```
+insert short code snippets here
+```
+
+**Other information:**
+<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. For visual or layout problems, please include images or animated gifs.-->
+
+**Environment**
+
+* atomic-crm version:
+* Last version that did not exhibit the issue (if applicable):
+* React version:
+* Browser:
+* Stack trace (in case of a JS error):

.github/ISSUE_TEMPLATE/Feature_request.md

@@ -0,0 +1,17 @@
+---
+name: "\U0001F680 Feature request"
+about: "I have a suggestion (and may want to implement it \U0001F642)!"
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -14,3 +14,5 @@ _Describe the steps required to test the changes_
 
 - [ ] The **documentation** is up to date
 - [ ] Tested with **fakerest** provider (see [related documentation](../doc/data-providers.md))
+
+Also, please make sure to read the [contributing guidelines](https://github.com/marmelab/atomic-crm#contributing).