search

andrewm4894 / anomstack

Anomstack - Painless open source anomaly detection for your metrics 📈📉🚀
https://andrewm4894.github.io/anomstack/
MIT License
83 stars 6 forks source link

chore: housekeeping using precommit and generic contributing guidelines #42

Closed harshalchaudhari35 closed 7 months ago

harshalchaudhari35 commented 7 months ago

Hi,

Had some time to poke around Anomstack and thought I would add a few quick things for housekeeping like pre-commit and a generic contribution guideline file. Let me know if what I have added aligns with you :)

Used this contribution file as inspiration https://github.com/TheAlgorithms/Python/blob/master/CONTRIBUTING.md in case you wanna cherry pick more

Changelog

Few things I would add next, I couldn't easily figure out what version of python the project supports without going through the Dockerfile, etc. and maybe as a next PR I was thinking to add pyproject.toml along with poetry to pin the pkgs and make Anomstack an installable package for local development. What do you think?

andrewm4894 commented 7 months ago

Cool, thanks! Been meaning to add pre-commit.

andrewm4894 commented 7 months ago

Also, re other ideas, totally makes sense, would be great to have some stuff like that.

harshalchaudhari35 commented 7 months ago

Also, re other ideas, totally makes sense, would be great to have some stuff like that.

cool, will raise another PR for it. I see the checkout step is failing for one of the gh actions, I can't see verbose logs to determine why its failing and if there is anything i can do to fix it...

andrewm4894 commented 7 months ago

I think that's just because my trial in dagster cloud has ended so it is read only and so deployment not working.

We can ignore here. Am chatting to them on slack to try sort.

andrewm4894 commented 7 months ago

here is all the stuff pre-commit wanted to clean up, just did the initial bulk of it via a PR in case it breaks anything - dont think it does as tested it locally.

(tests is something we will need soon for sure)

https://github.com/andrewm4894/anomstack/pull/43/

andrewm4894 commented 7 months ago

also added pre-commit as a gh action here: https://github.com/andrewm4894/anomstack/pull/43/commits/dfac954a1f00f7007f7016d31c62f9c90e2ecd4a