Merge pull request #563 from DocNow/twarc_purpose

edsu · web-flow · commit 2053ef613e32 · 2021-10-22T08:27:44.000-04:00
Add some notes about the purpose of core twarc and principles about w&hellip;
diff --git a/README.md b/README.md
@@ -1,16 +1,26 @@
 # twarc
 
-
-
 [![DOI](https://zenodo.org/badge/7605723.svg)](https://zenodo.org/badge/latestdoi/7605723) [![Build Status](https://github.com/docnow/twarc/workflows/tests/badge.svg)](https://github.com/DocNow/twarc/actions/workflows/main.yml)
 
-Collect data at the command line from the Twitter API (v1.1 and v2).
+twarc is a command line tool and Python library for collecting and archiving Twitter JSON
+data via the Twitter API. It has separate commands (twarc and twarc2) for working with the older
+v1.1 API and the newer v2 API and Academic Access (respectively).
 
 * Read the [documentation](https://twarc-project.readthedocs.io)
 * Ask questions in [Slack](https://bit.ly/docnow-slack) or [Matrix](https://matrix.to/#/#docnow:matrix.org?via=matrix.org&via=petrichor.me&via=converser.eu)
 
+
 ## Contributing 
 
+New features are welcome and encouraged for twarc. However, to keep the core twarc library and command line tool sustainable we will look at new functionality with the following principles in mind:
+
+1. Purpose: twarc is for *collection* and *archiving* of Twitter data via the Twitter API.
+2. Sustainability: keeping the surface area of twarc and it's dependencies small enough to ensure high quality.
+3. Utility: what is exposed by twarc should be applicable to different people, projects and domains, and not specific use cases.
+4. API consistency: as much as sensible we aim to make twarc consistent with the Twitter API, and also aim to make twarc consistent with itself - so commands in core twarc should work similarly to each other, and twarc functionality should align towards the Twitter API.
+
+For features and approaches that fall outside of this, twarc enables external packages to hook into the twarc2 command line tool via [click-plugins](https://github.com/click-contrib/click-plugins). This means that if you want to propose new functionality, you can create your own package without coordinating with core twarc.
+
 ### Documentation
 
 The documentation is managed at ReadTheDocs. If you would like to improve the documentation you can edit the Markdown files in `docs` or add new ones. Then send a pull request and we can add it.
diff --git a/docs/README.md b/docs/README.md
@@ -1,7 +1,7 @@
 # twarc
 
-twarc is a command line tool and Python library for archiving Twitter JSON
-data. It has separate commands (twarc and twarc2) for working with the older
+twarc is a command line tool and Python library for collecting and archiving Twitter JSON
+data via the Twitter API. It has separate commands (twarc and twarc2) for working with the older
 v1.1 API and the newer v2 API and Academic Access (respectively). It also has an ecosystem of [plugins](plugins) for doing things with the collected data. 
 
 See the `twarc` documentation for running commands: [twarc2](twarc2_en_us.md) and [twarc1](twarc2_en_us.md) for using the v1.1 API. If you aren't sure about which one to use you'll want to start with twarc2 since the v1.1 is scheduled to be retired.
@@ -15,6 +15,7 @@ pip3 install twarc
 ```
 
 Once installed, you should be able to use the twarc and twarc2 command line utilities, or use it as a Python library - check the examples [here](api/library.md) for that.
+
 ## Other Tools
 
 Twarc is purpose build for working with the twitter API for archiving and studying digital trace data. It is not built as a general purpose API library for Twitter. While the primary use is academic, it works just as well with "Standard" v2 API and "Premium" v1.1 APIs.
