search

creativecommons / quantifying

quantify the size and diversity of the commons--the collection of works that are openly licensed or in the public domain
MIT License
22 stars 30 forks source link

[Feature] Tooling (ex. black, flake8, isort) documentation needs improvement #53

Closed TimidRobot closed 9 months ago

TimidRobot commented 1 year ago

Problem

Currently the tooling documentation is simply a list of references:

https://github.com/creativecommons/quantifying/blob/8c444b52f560b034ecf464dafdea34ca520afc91/README.md?plain=1#L68-L79

It does not mention the helper script:

./dev/tools.sh

It does not mention the GitHub Action (.github/workflows/python_static_analysis.yml)

Description

The documentation could be more comprehensive and helpful.

Paulooh007 commented 1 year ago

Hi @TimidRobot i'll love to work on this. Could you please assign it to me?

satyampsoni commented 1 year ago

Hello @TimidRobot I want to work on it. Can you pls assign it to me?

TimidRobot commented 1 year ago

Please see Contribution Guidelines — Creative Commons Open Source for how we manage issues and PRs (we generally don't assign issues prior to resolution).