diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7723a27 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,12 @@ +# Contributing + +We welcome all contributions, however here are some guidelines: + +* For large changes please discuss them in an issue first +* Use feature branches for your changes +* Ensure the commits you're submitting are tidy, and reasonable (rebase if necessary) +* Please ensure scrutinizer isn't reporting any new issues +* You have added new tests for new functionality if you are adding it. +* You are following our [code of conduct][coc] + +[coc]: code_of_conduct.md diff --git a/README.md b/README.md index 5aebd67..18ff65c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ htmlstrip -============== +========= A class to convert a small subset of html into something reasonable you can put in plain text email, or SMS. @@ -25,11 +25,6 @@ $htmlStripper->("

Hello, world.

") // -> "Hello, world." ``` -Versioning ----------- - -We use [semver](http://semver.org/). See the [releases](https://github.com/PurpleBooth/htmlstrip/releases) for a changelog and versions - Examples -------- Input: @@ -127,3 +122,10 @@ Related ------- * [Twig Extension](https://github.com/PurpleBooth/twig-htmlstrip) + + +Versioning +---------- + +We use [semver](http://semver.org/). See the [releases](https://github.com/PurpleBooth/htmlstrip/releases) for a changelog and versions + diff --git a/code_of_conduct.md b/code_of_conduct.md new file mode 100644 index 0000000..c6121e0 --- /dev/null +++ b/code_of_conduct.md @@ -0,0 +1,75 @@ +# 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 [billie@purplebooth.co.uk][email]. 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/ +[email]: mailto:reports@purplebooth.co.uk