functime-org / functime

Time-series machine learning at scale. Built with Polars for embarrassingly parallel feature extraction and forecasts on panel data.
https://docs.functime.ai
Apache License 2.0
1.02k stars 55 forks source link

chore: Add CONTRIBUTING.md #189

Closed baggiponte closed 5 months ago

baggiponte commented 6 months ago

Adding a draft for CONTRIBUTING.md. Would like to ask for a review to @ngriffiths13, @FBruzzesi, @miroslaavi who is working on a PR and installed the project locally, and also @ rodrigogiraoserrao because he says they are important (🤪).

vercel[bot] commented 6 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
functime-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 16, 2024 4:30pm
baggiponte commented 5 months ago

Thanks for the comments! I was actually curious how you set the project up.

I'm a bit obsessed with the conventional commits but I'm sure we also use it for our changelog, so it has a purpose. Will add that part 😊

Speaking of branches: I don't think it really matters as long as it is understandable. Will mention that. (Also I did not forget about the PR but this is something that I postponed a bit too much.)

miroslaavi commented 5 months ago

Cool, that's clear, thanks!

Hmm, I set the project up by first downloading Rust (as that is something I have no prior experience of, but have started thinking about learning it), and then I think I just ran the Makefile "edit" if I recall right.. Rye also something new for me that need to look up :)