-
-
Notifications
You must be signed in to change notification settings - Fork 180
Description
WHAT
There are no build and test instructions in the readme here, or in sf3fs.
WHY
This is important to get other developers interested in contributing.
HOW
Personally, I use poetry
and pyenv
to structure my Python projects. I also like make
and tend to surface my projects in exactly the same way as in this project. With one exception. I typically provide some sort of environment configuration task to download all the various bits needed to build/test/doc etc. With that said, I find using poetry
and noxfiles
vastly simplifies these things. Here's what would make this project much easier to contribute to...in increasing order of effort:
- Dependencies : document all the deps I need to install to build and test thes repos (incl. s3fs)
- Makefile : add a task to download and install all the goodies needed
- Or move beyond Makefiles and tox and upgrade to
poetry
,nox
, etc.
Just adding documentation would be enough. Extending this to the Makefiles would be great. Upgrading to poetry
and nox
would be awesome.
Here are some links for context as to what I'm suggesting: