Checklist for 0.1 release

JuliaAI / MLJText.jl

A an MLJ extension for accessing models and tools related to text analysis

MIT License

11 stars 1 forks source link

Checklist for 0.1 release #5

Closed ablaom closed 2 years ago

ablaom commented 2 years ago

These are my suggestions:

[x] Check coverage. I'd be happy with > 80%
[x] Re-organize the transformer and tests into separate files to facilitate future extension
[x] Add documentation. I'd be happy with dumping the transformer docstring into the README.md for now. But if someone wants to do something more elaborate.... . My suggestion would be to keep the documentation local, ie, not add to MLJ central docs. We can put a link there.
[x] Immigration of scitype stuff #7 @ablaom to do
[x] Check we have complete set of [compat] entries including julia version
[x] CI passing
[x] Create a new master branch and merge a "For a 0.1 release" PR dev -> master

@pazzo83 @storopoli Feel free to add to this.

storopoli commented 2 years ago

Maybe a simple "hello world" example with the documentation?

pazzo83 commented 2 years ago

Agree on all this - what's the best way to set up coverage? I think I saw some output in the CI where our coverage was above 80%. In terms of reorganizing the transformer/tests - do you mean putting what we've defined into a separate file (and the corresponding tests as well)?

ablaom commented 2 years ago

Coverage is setup. The readme icon is not showing the coverage for reasons I do not understand, but if I click on it, it takes you to the detailed analysis (which is > 80%). Maybe if we make a few more PR's it will fix itself. As I say, 80% is okay with me but it might be worth just scanning the analysis to see what is missing.

In terms of reorganizing the transformer/tests - do you mean putting what we've defined into a separate file (and the corresponding tests as well)?

Yes. Just move your code to src/tfidf_transformer.jl and your tests to test/tifid_transformer.jl and add includes to bring those in. Make sense?

ablaom commented 2 years ago

Okay, revisiting coverage, I realised that the new scitype tests are orphaned. 🙄 Working on a fix now.

edit Done.

ablaom commented 2 years ago

@pazzo83 You happy for me to release this now?

pazzo83 commented 2 years ago

Absolutely! Thank you for all of your help with this!!

ablaom commented 2 years ago

No worries. Thanks for your patience.

ablaom commented 2 years ago

@pazzo83 @storopoli https://github.com/JuliaRegistries/General/pull/47044

storopoli commented 2 years ago

Great!!! Happy to help you guys!