diff --git a/.Rbuildignore b/.Rbuildignore index 91114bf..8af6a08 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,2 +1,3 @@ ^.*\.Rproj$ ^\.Rproj\.user$ +^CONDUCT\.md$ diff --git a/CONDUCT.md b/CONDUCT.md new file mode 100644 index 0000000..65c05c5 --- /dev/null +++ b/CONDUCT.md @@ -0,0 +1,22 @@ +# Contributor Code of Conduct + +As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery +* Personal attacks +* Trolling or insulting/derogatory comments +* Public or private harassment +* Publishing other's private information, such as physical or electronic addresses, without explicit permission +* Other unethical or unprofessional conduct. + +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. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team. + +This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. + +This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/) \ No newline at end of file diff --git a/DESCRIPTION b/DESCRIPTION index 34e4288..bf174e6 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,20 +1,20 @@ Package: wmf Type: Package Title: R Code for Wikimedia Foundation Internal Usage -Version: 0.2.0 -Date: 2015-09-22 +Version: 0.2.1 +Date: 2015-09-30 Authors@R: c( person("Oliver", "Keyes", email = "oliver@wikimedia.org", role = "cre"), person("Mikhail", "Popov", email = "mpopov@wikimedia.org", role = "aut")) Description: More about what it does (maybe more than one line). License: What license is it under? LazyData: TRUE Imports: RMySQL, urltools, pwr, ggplot2, ggthemes URL: https://github.com/Ironholds/wmf BugReports: https://github.com/Ironholds/wmf/issues Suggests: testthat diff --git a/NEWS b/NEWS deleted file mode 100644 index 206be15..0000000 --- a/NEWS +++ /dev/null @@ -1,7 +0,0 @@ -wmf 0.1.1 -============= -* Fix a bug in global_query - -wmf 0.1.0 -============= -Initial release \ No newline at end of file diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 0000000..4d51f88 --- /dev/null +++ b/NEWS.md @@ -0,0 +1,15 @@ +wmf 0.2.1 +============= +* Adds a Contributor Code of Conduct + +wmf 0.2.0 +============= +* Adds compatibility with RMySQL 0.9.4+ + +wmf 0.1.1 +============= +* Fix a bug in global_query + +wmf 0.1.0 +============= +Initial release diff --git a/README.md b/README.md index 63ff62a..4475517 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,20 @@ -## Internal tools for WMF data analysts +# Internal tools for WMF data analysts A lot of code is generalisable. Some code is not. This package contains functions generalisable to "people at the Wikimedia Foundation" but "too scattered and not useful enough for people outside it" including: 1. `set_proxies()` to set http/s proxies on the analytics cluster; 2. `global_query()` for querying all of our MySQL databases; 3. `from_mediawiki` and `from_log` (and corresponding `to_*` functions) to convert between time formats, and; 4. `hive_query` for hitting up our HDFS store. 5. `sample_size_odds` and `sample_size_effect` for calculating sample size(s) given an odds ratio or effect size (Cohen's *w*). More functions as people need them. -### Installation +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. + +## Installation ``` - devtools::install_github("ironholds/wmf") - +devtools::install_github("ironholds/wmf") ```