aboutsummaryrefslogtreecommitdiffstats
path: root/docs/contributing.md
Commit message (Collapse)AuthorAgeFilesLines
* Document how to format and lint the codeTrygve Aaberge2021-06-231-2/+20
| | | | Fixes #842
* Remove section about adding dependencies from contributing docsTrygve Aaberge2020-10-041-28/+0
| | | | | | | Since people install this either just by copying the script, or by installing it from WeeChats repo, and neither of these methods install dependencies automatically, I really want to keep dependencies to a minimum. So I don't think it's useful to document how to add new ones.
* feat: use pipenv to manage the development environment (#784)Ben Denhartog2020-10-041-0/+84
[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