diff --git a/.verb.md b/.verb.md index 55553d0..aec6988 100644 --- a/.verb.md +++ b/.verb.md @@ -105,6 +105,9 @@ Released under the [{%= license %} License][license-url]. [downloads-monthly-img]: https://img.shields.io/npm/dm/{%= name %}.svg [downloads-total-img]: https://img.shields.io/npm/dt/{%= name %}.svg +[nodeversion-url]: https://nodejs.org/en/download +[nodeversion-img]: https://img.shields.io/node/v/{%= name %}.svg + [renovateapp-url]: https://renovatebot.com [renovateapp-img]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..b643345 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# 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 `olsten.larck@gmail.com` mail address. 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 [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c9731d2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing Guide :100: + +> _Hello stranger! :sparkles: Please, read the [Code Of Conduct](./CODE_OF_CONDUCT.md) and the full guide at +[tunnckoCore/contributing](https://github.com/tunnckoCore/contributing)! +> Even if you are an experienced developer or active open source maintainer, it worth look over there._ + +![welcome-teal](https://cloud.githubusercontent.com/assets/194400/22215755/76cb4dbc-e194-11e6-95ed-7def95e68f14.png) + +> “_Every thought, **every word**, and **every action** +that **adds to** the **positive** is a **contribution to peace**.
+Each and **every one** of us is **capable** of making such a **contribution**_.” +~ [Aung San Suu Kyi](https://en.wikipedia.org/wiki/Aung_San_Suu_Kyi) + + + +## Are you new to Open Source? + +If you’re a **new** open source contributor, the process can be intimidating. +_What if you don’t know how to code?_ What if something goes wrong? **Don't worry!** + +**You don’t have to contribute code!** A common misconception about contributing to open source is that you +need to _contribute code_. In fact, it’s often the other parts of a project that are most neglected or +overlooked. You’ll do the project a _huge favor_ by offering to pitch in with these types of +**contributions**! + +**Even if you like to write code**, other types of contributions are a great way to get involved with a +project and meet other community members. Building those relationships will give you opportunities to work on +other parts of the project.