Browse Source

code of conduct

boB Rudis 2 years ago
parent
commit
71bf028803
3 changed files with 30 additions and 2 deletions
  1. 1
    0
      .Rbuildignore
  2. 25
    0
      CONDUCT.md
  3. 4
    2
      README.Rmd

+ 1
- 0
.Rbuildignore View File

@@ -6,3 +6,4 @@
6 6
 ^NOTES\.*Rmd$
7 7
 ^NOTES\.*html$
8 8
 ^img$
9
+^CONDUCT\.md$

+ 25
- 0
CONDUCT.md View File

@@ -0,0 +1,25 @@
1
+# Contributor Code of Conduct
2
+
3
+As contributors and maintainers of this project, we pledge to respect all people who 
4
+contribute through reporting issues, posting feature requests, updating documentation,
5
+submitting pull requests or patches, and other activities.
6
+
7
+We are committed to making participation in this project a harassment-free experience for
8
+everyone, regardless of level of experience, gender, gender identity and expression,
9
+sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
10
+
11
+Examples of unacceptable behavior by participants include the use of sexual language or
12
+imagery, derogatory comments or personal attacks, trolling, public or private harassment,
13
+insults, or other unprofessional conduct.
14
+
15
+Project maintainers have the right and responsibility to remove, edit, or reject comments,
16
+commits, code, wiki edits, issues, and other contributions that are not aligned to this 
17
+Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed 
18
+from the project team.
19
+
20
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by 
21
+opening an issue or contacting one or more of the project maintainers.
22
+
23
+This Code of Conduct is adapted from the Contributor Covenant 
24
+(http:contributor-covenant.org), version 1.0.0, available at 
25
+http://contributor-covenant.org/version/1/0/0/

+ 4
- 2
README.Rmd View File

@@ -23,7 +23,7 @@ All you need for this package to work is a running Splash instance. You provide
23 23
 
24 24
 ### About Splash
25 25
 
26
->'Splash' <https://github.com/scrapinghub/splash> is a javascript rendering service. It’s a lightweight web browser with an 'HTTP' API, implemented in Python using 'Twistedand 'QT' and provides some of the core functionality of the 'RSelenium' or 'seleniumPipes' R packages but with a Java-free footprint. The (twisted) 'QT' reactor is used to make the sever fully asynchronous allowing to take advantage of 'webkit' concurrency via QT main loop. Some of Splash features include the ability to process multiple webpages in parallel; retrieving HTML results and/or take screenshots; disabling images or use Adblock Plus rules to make rendering faster; executing custom JavaScript in page context; getting detailed rendering info in HAR format.
26
+>'Splash' <https://github.com/scrapinghub/splash> is a javascript rendering service. It’s a lightweight web browser with an 'HTTP' API, implemented in Python using 'Twisted'and 'QT' and provides some of the core functionality of the 'RSelenium' or 'seleniumPipes' R packages but with a Java-free footprint. The (twisted) 'QT' reactor is used to make the sever fully asynchronous allowing to take advantage of 'webkit' concurrency via QT main loop. Some of Splash features include the ability to process multiple webpages in parallel; retrieving HTML results and/or take screenshots; disabling images or use Adblock Plus rules to make rendering faster; executing custom JavaScript in page context; getting detailed rendering info in HAR format.
27 27
     
28 28
 The following functions are implemented:
29 29
 
@@ -134,4 +134,6 @@ date()
134 134
 test_dir("tests/")
135 135
 ```
136 136
 
137
-```{r eval = FALSE, include = FALSE}
137
+### Code of Conduct
138
+
139
+Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.

Loading…
Cancel
Save