aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorBen Denhartog <3893293+sudoforge@users.noreply.github.com>2020-10-04 08:40:34 -0600
committerGitHub <noreply@github.com>2020-10-04 16:40:34 +0200
commitb51a1c8a466c9737fc0baa515066ac712b9b7233 (patch)
tree27f9f6ef7690177df396ea90ab4ae61a0c49ab2e /README.md
parent52943dd4095ea44f0664fc521427dd37c982e852 (diff)
downloadwee-slack-b51a1c8a466c9737fc0baa515066ac712b9b7233.tar.gz
feat: use pipenv to manage the development environment (#784)
[Pipenv][0] makes it easier to maintain a consistent development environment for projects using Python. You no longer need to manage `pip` and `virtualenv` separately, nor deal with the drift and other issues requirements.txt brings. It enables gaining insights into your dependency graph, but most importantly - it enables deterministic builds, which prevents the entire class of "it works on my machine" problems. [Pipenv][0] is similar to package managers from other ecosystems, such as Node.js' `npm` or Rust's `cargo`. Additionally, [Pipenv][0] is an [officially recommended package manager][1] by the Python project. This patch brings [Pipenv][0] to the wee-slack project to simplify the development and contribution experience. Additionally, this patch brings basic contributing documentation to help onboarding. [0]: https://github.com/pypa/pipenv [1]: https://packaging.python.org/tutorials/managing-dependencies/#managing-dependencies
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index dcbfbfd..cb827ec 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,7 @@ A WeeChat native client for Slack.com. Provides supplemental features only avail
Table of Contents
-----------------
* [Features](#features)
+ * [Contributing](#contributing)
* [Dependencies](#dependencies)
* [Setup](#setup)
* [1. Install dependencies](#1-install-dependencies)
@@ -58,6 +59,11 @@ Features
* Expands/shows metadata for things like tweets/links
* *Super fun* debug mode. See what the websocket is saying
+Contributing
+------------
+
+See [docs/contributing.md](./docs/contributing.md).
+
Dependencies
------------
* WeeChat 1.3+ http://weechat.org/