Contribution Guideline and Tutorial Notebook

appledora / mwparserfromhtml

An unofficial mirror of our repo of the `mwparserfromhtml` package. It is a python library for working with the HTML dumps. Since this is only a mirror, DO NOT PR.

https://pypi.org/project/mwparserfromhtml/

MIT License

4 stars 0 forks source link

Contribution Guideline and Tutorial Notebook #42

Open appledora opened 2 years ago

appledora commented 2 years ago

Eventually we would need a contribution guideline, since this is an OSS project.
A tutorial notebook, would be better at explaining the context and use-cases of the library, than the README.md

appledora commented 2 years ago

@geohci, I added a basic CONTRIBUTION.md, a couple of tutorials and a pre-commit hook in the workflow. But unfortunately I have pushed all of those in the main branch :| If this is good to go, I will publish the package to the official pyPI.

appledora commented 2 years ago

In GitLab by @geohci on Sep 26, 2022, 21:57

@appledora thanks for pulling together these pieces! A few points:

I'll take a look more extensively and either file issues or add comments to this issue if I see anything that should be changed. I'll close this issue when the review is complete then.
I actually went ahead and published the official PyPi package last week. We can coordinate so I add you and Martin as maintainers and figure out how to manage releases a bit more automatically via Gitlab

appledora commented 2 years ago

That's great to hear, @geohci !! But you should really upgrade the pyPI version, because the README.md has some outdated usage of the library and people might fall for it.