search

aroberge / ideas

Easy creation of custom import hooks to experiment on alternatives to Python's syntax; see https://aroberge.github.io/ideas/docs/html/
Other
76 stars 5 forks source link

Add a contributor's guide or automate it somehow #34

Open zmievsa opened 2 years ago

zmievsa commented 2 years ago

It wasn't too bad to contribute but I faced a lot of unknown issues and guessed my way through (for example, with pre-commit + pytest + black and with black-click incompatibility). Good thing I know which tools are necessary in general and how to use them (or solve issues with them). But I am afraid that a less experienced programmer will not be able to figure these things out without giving up.

aroberge commented 2 years ago

I agree.

To be honest, I didn't expect any collaborators when I started this project. My purpose was just to learn about how to use import hooks, and other stuff from there. In my other projects, where I do expect (/hope for) some collaboration, I try to provide some help. Using friendly-traceback as an example:

developer's notes requirements [requirements-dev](https://github.com/friendly-traceback/friendly-traceback/blob/main/requirements-dev.txt]

I can see now that I should do something similar for ideas. And I can see how using some tool like poetry with a configuration file would easily take care of providing all the required information.

I'll reopen the poetry issue!

aroberge commented 2 years ago

This should now be taken care of via #35. However, I personally have some unanswered questions which I need to figure out before closing this issue.

  1. I use SublimeMerge to manage commits. I have installed pre-commit in my default Python version which, I assume, is the one picked up by SublimeMerge. I need to figure out how to ensure that pre-commit is using the correct Python version. I suspect that it might pick up the information from the pyproject.toml file.
  2. Poetry does not work with Python 3.11(.0b1). Yet, I want to test it so I need to install dependencies "by hand". I need to figure out if pip can use the information from pyproject.toml.

to be continued.

zmievsa commented 2 years ago

Are you sure you wish to support the most recent version of python? Even the most popular packages don't do that because it's usually a pain :)

I am also not sure that pre-commit will pickup stuff from pyproject. Need to research that.