Merge pull request #5 from adrienv1520/develop

1.1.1

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# 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 email
+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]**. 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 this 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](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html) version 1.4.
+
+For answers to common questions about this Code of Conduct, please see
+https://www.contributor-covenant.org/faq.

.github/CONTRIBUTING.md

@@ -0,0 +1,107 @@
+# Contributing
+Here are the guidelines we'd like you to follow:
+
+- [Development](#development)
+- [Issues and Bugs](#issue)
+- [Feature Requests](#feature)
+- [Pull Request Submission Guidelines](#submit-pr)
+- [Commit Message Conventions](#commit)
+
+## Development
+Any contributor of this project should follow:
+- [Git flow](https://danielkummer.github.io/git-flow-cheatsheet/);
+- [ES6/7 features](https://github.com/lukehoban/es6features);
+- [Airbnb's Javascript Style Guide](https://github.com/airbnb/javascript) within [ESLint](https://github.com/adrienv1520/esbnb).
+
+## <a name="issue"></a> Found an Issue or Bug?
+Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
+
+A minimal reproduce scenario allows us to quickly confirm a bug (or point out config problems) as well as confirm that we are fixing the right problem.
+
+We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it.
+
+Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you we are going to close an issue that doesn't have enough info to be reproduced.
+
+## <a name="feature"></a> Feature Requests?
+You can *request* a new feature by creating an issue on GitHub.
+
+If you would like to *implement* a new feature, please submit an issue with a proposal for your work **first**, to be sure that particular feature makes sense for the project.
+
+Once the issue submitted, always start your feature from creating a new branch from `develop` and not `master` as we may have some features still not ready to be merged to `master` yet.
+
+## <a name="submit-pr"></a> Pull Request Submission Guidelines
+Before you submit your Pull Request (PR) consider the following guidelines:
+
+- Search Github for an open or closed PR that relates to your submission. You don't want to duplicate effort;
+- Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). Adherence to these conventions is necessary because release notes are automatically generated from these messages;
+- Fill out our `Pull Request Template`. Your pull request will not be considered if it is ignored.
+
+## <a name="commit"></a> Commit Conventions
+Each commit message consists of a **header**, a **body** and a **footer**.
+
+The header has a special format that includes a **type**, a **scope** and a **subject**:
+
+```
+{type}({scope}): {subject}
+{BLANK LINE}
+{body}
+{BLANK LINE}
+{footer}
+```
+
+The **header** is mandatory and the **scope** of the header is optional.
+
+Any line of the commit message cannot be longer than 100 characters. This allows the message to be easier to read on GitHub as well as in various git tools.
+
+The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
+
+Examples:
+
+```
+docs(readme): update error codes
+```
+
+```
+fix: refer to the `entrypoint` instead of the first `module`
+```
+
+### Header
+
+#### Type
+Must be one of the following:
+
+- **build**: Changes that affect the build system or external dependencies (example: npm);
+- **chore**: Changes that fall outside of build / docs that do not effect source code (examples: package, defaults);
+- **ci**: Changes to CI configuration files and scripts (examples: circleci, travis);
+- **docs**: Documentation-only changes (examples: readme, changelog);
+- **feature**: A new feature;
+- **fix**: A bug fix;
+- **perf**: A code change that improves performance;
+- **refactor**: A code change that neither fixes a bug nor adds a feature;
+- **revert**: Used when reverting a committed-change;
+- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons);
+- **test**: Addition of or updates to tests.
+
+#### Scope
+The scope is subjective and depends on the `type` see above. A good example would be a change to a particular class/module.
+
+#### Subject
+The subject contains a succinct description of the change:
+
+- use the imperative, present tense: "change" not "changed" nor "changes";
+- don't capitalize the first letter;
+- no dot (".") at the end.
+
+### Body
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
+
+### Footer
+The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two new lines and the rest of the commit message.
+
+### Revert
+If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit {hash}.`, where the hash is the SHA of the commit being reverted.
+
+## Thank you
+Thank you for your interest, time, understanding, and for following this guide.

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,44 @@
+---
+name: Bug report
+about: Create a report to help us improve esbnb
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!--
+  As an open source project with a dedicated but small maintainer team,
+  it can sometimes take a long time for issues to be addressed so please
+  be patient and we will get back to you as soon as we can.
+-->
+
+### Preflight Checklist
+<!-- Please ensure you've completed the following steps by replacing [ ] with [x] -->
+
+* [ ] I have read the [Contributing Guidelines](../CONTRIBUTING.md) for this project;
+* [ ] I agree to follow the [Code of Conduct](../CODE_OF_CONDUCT.md) that this project adheres to;
+* [ ] I have searched the [issue tracker](https://github.com/adrienv1520/esbnb/issues) for an issue that matches the one I want to file, without success.
+
+### Bug Details
+
+* **Operating System**:
+* **Node Version**:
+* **NPM Version**:
+* **esbnb Version**:
+* **Last Known Working esbnb Version**:
+
+### Expected Behavior
+<!-- A clear and concise description of what you expected to happen. -->
+
+### Actual Behavior
+<!-- A clear and concise description of what actually happened. -->
+
+### To Reproduce
+<!-- Your best chance of getting this bug looked at quickly is to provide an example. -->
+
+### Screenshots
+<!-- If applicable, add screenshots to help explain your problem. -->
+
+### Additional Information
+<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,27 @@
+---
+name: Feature request
+about: Suggest an idea for esbnb
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Preflight Checklist
+<!-- Please ensure you've completed the following steps by replacing [ ] with [x] -->
+
+* [ ] I have read the [Contributing Guidelines](../CONTRIBUTING.md) for this project;
+* [ ] I agree to follow the [Code of Conduct](../CODE_OF_CONDUCT.md) that this project adheres to;
+* [ ] I have searched the [issue tracker](https://github.com/adrienv1520/esbnb/issues) for an issue that matches the one I want to file, without success.
+
+### Problem Description
+<!-- Is your feature request related to a problem? Please add a clear and concise description of what the problem is. -->
+
+### Proposed Solution
+<!-- Describe the solution you'd like in a clear and concise manner. -->
+
+### Alternatives Considered
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+### Additional Information
+<!-- Add any other context about the problem here. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,34 @@
+#### What does this PR contain?
+
+<!--
+  Thank you for your Pull Request.
+  Remove items that do not apply. For completed items, change [ ] to [x].
+-->
+
+- [ ] **bugfix**
+- [ ] new **feature**
+- [ ] **code refactor**
+- [ ] **test update** <!-- if bug or feature is checked, this should be too -->
+- [ ] **typo fix**
+- [ ] **metadata update**
+- [ ] **dependency update**
+- [ ] **documentation update**
+
+#### Motivation / Use-Case
+
+<!--
+  Please explain the motivation or use-case for your change.
+  What existing problem does the PR solve?
+  If this PR addresses an issue, please link to the issue.
+-->
+
+#### Breaking Changes
+
+<!--
+  If this PR introduces a breaking change, please describe the impact and a
+  migration path for existing applications.
+-->
+
+#### Release Notes
+
+<!-- Please add a one-line description for maintainers to read in the release notes. -->

.github/SECURITY.md

@@ -0,0 +1,19 @@
+# Security Policy
+
+Our security policy is to avoid leaving the ecosystem worse than we found it. Meaning we are not planning to introduce vulnerabilities into the ecosystem.
+
+The esbnb team and community take security bugs in esbnb seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
+
+Your responsibility is to report vulnerabilities to us using the guidelines outlined below.
+
+To report a security issue please do the following:
+* Email [[email protected]](mailto:[email protected]);
+* Include the word "SECURITY" in the subject line;
+* Give your name and affiliation (if any);
+* Include scope of vulnerability by letting us know who could use this exploit;
+* Document steps to identify the vulnerability so we can reproduce your findings;
+* Show how to exploit vulnerability, give us an attack scenario.
+
+The esbnb team will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.
+
+Report security bugs in third-party modules to the person or team maintaining the module. You can also report a vulnerability through the [npm contact form](https://www.npmjs.com/support) by selecting *I'm reporting a security vulnerability*.

.github/SUPPORT.md

@@ -0,0 +1,40 @@
+# Support
+
+## Finding Support
+If you have a security concern,
+please see our [security page](SECURITY.md).
+
+If you're looking for programming help,
+for answers to questions,
+or to discuss with the team,
+please feel free to contact the project team at **[email protected]**.
+
+If you'd like to contribute to esbnb,
+see our [Contributing Guidelines](CONTRIBUTING.md)
+and our [TODO](../TODO.md).
+
+If you've found a bug in a [supported version](#supported-versions)
+of esbnb, please report it with the
+[issue tracker](https://github.com/adrienv1520/esbnb/issues).
+
+## Supported Versions
+The latest *stable* major version is currently supported by the team.
+For example, if the latest release is 1.6.y, then the 1.x.y versions are supported.
+
+The latest stable release unilaterally receives all fixes from `master`,
+and the version prior to that receives the vast majority of those fixes
+as time and bandwidth warrants.
+
+### Currently supported versions
+
+- 1.x.y
+
+### End-of-life
+When a release branch reaches the end of its support cycle, the series
+will be deprecated in NPM and a final end-of-support release will be
+made. This release will add a warning to inform that an unsupported
+version of esbnb is in use.
+
+These steps are to help developers learn when a branch they're
+using becomes unsupported, but without being excessively intrusive
+to end users.

CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 1.1.1 - delivery @12/06/2021
+
+- update dependencies
+- add github community files
+- update readme
+- add todo
+- update tests
+
 ## 1.1.0 - delivery @06/01/2020
 
 - upgrade dependencies' version

LICENSE.md

@@ -0,0 +1,9 @@
+*esbnb* is released under the MIT license.
+
+Copyright (C) 2021 Adrien Valcke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.