From 6b194c6ebb5e8c6de0eec388ed46056cbc9db887 Mon Sep 17 00:00:00 2001 From: matthew Date: Fri, 25 Aug 2023 13:39:59 +0300 Subject: [PATCH] Typo, contributing and conduct docs --- CODE_OF_CONDUCT.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 20 ++++++++++++++++++++ README.md | 2 +- 3 files changed, 68 insertions(+), 1 deletion(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..9a0b1b9 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,47 @@ +# *Code Of Conduct* + +--- +Just like any other technical community, Scrapy-puppeteer team and community is made up +of many people from all over the world. We want to join them into one huge community of *Scrapy-puppeteer*. + +As there are many diverse people with different points of view, we decided to write rules for contributing, +issue declaring and discussion. We hope everybody would follow them and enjoy spending time within the community! + +This code of conduct applies to all spaces managed by Scrapy-puppeteer project and to all members +of its community. + +If you believe someone is violating the code of conduct, we ask that you report it by +emailing us. + +* Be friendly and patient. +* Be welcoming. We strive to be a community that welcomes and supports people of all backgrounds and identities. +This includes, but is not limited to members of any race, ethnicity, culture, national origin, colour, immigration +status, social and economic class, educational level, sex, age, size, family status, political belief, religion, +and mental and physical ability. +* Be considerate. Your work will be used by other people, and you in turn will depend on the work of others. +Any decision you take will affect users and colleagues, and you should take those consequences into account +when making decisions. Remember that we're a world-wide community, so you might not be communicating in +someone else's primary language. +* Be respectful. Not all of us will agree all the time, but disagreement is no excuse for poor behavior or +bad manners. We might all experience some frustration now and then, but we cannot allow that frustration to +turn into a personal attack. It’s important to remember that a community where people feel uncomfortable or +threatened is not a productive one. Members of the Scrapy-puppeteer community should be respectful when dealing +with other members as well as with people outside the community. +* Be careful in the words that you choose. We are a community of professionals, and we conduct ourselves +professionally. Be kind to others. Do not insult or put down other participants. Harassment and other exclusionary +behavior aren't acceptable. This includes, but is not limited to: + 1. Violent threats or language directed against another person. + 2. Discriminatory jokes and language. + 3. Posting (or threatening to post) other people's personally identifying information ("doxing"). + 4. Personal insults. + 5. Advocating for, or encouraging, any of the above behavior. + 6. Repeated harassment of others. In general, if someone asks you to stop, then stop. +* When we disagree, try to understand why. Disagreements, both social and technical, happen all the time and +Scrapy-puppeteer is no exception. It is important that we resolve disagreements and differing views constructively. +Remember that we’re different. The strength of Scrapy-puppeteer comes from its varied community, people from a +wide range of backgrounds. Different people have different perspectives on issues. Being unable to understand why +someone holds a viewpoint doesn’t mean that they’re wrong. Don’t forget that it is human to err and blaming +each other doesn’t get us anywhere. Instead, focus on helping to resolve issues and learning from mistakes. + + +Original text from [DJango](https://www.djangoproject.com/conduct/). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b204037 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# Contributing to Scrapy-puppeteer + +--- +As an open source project, Scrapy-puppeteer welcomes contributions of many forms. + +Examples of contributions include: + +* Code patches +* Documentation improvements +* Bug reports and patch reviews + +**Warning: any pull request without informative title, meaningful description will be closed!** + +`Please formalize your pull request (PR)` you will get. + +--- +# Code of Conduct + +As a contributor, you can help us keep the Scrapy-puppeteer community open and inclusive. +Please read and follow our [Code Of Conduct](https://github.com/ispras/scrapy-puppeteer/blob/master/CODE_OF_CONDUCT.md). diff --git a/README.md b/README.md index b152c37..ff14805 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# scrapy-puppeteer-client +# Scrapy-puppeteer-client This package aims to manage Chrome browser with [Puppeteer](https://github.com/GoogleChrome/puppeteer) from [Scrapy](https://github.com/scrapy/scrapy/) spiders. This allows to scrape sites that require JS to function properly and to make the scraper more similar to humans. It is a client library for [scrapy-puppeteer-service](https://github.com/ispras/scrapy-puppeteer-service).