Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: updated setup for a new contributor #149

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

ngupta23
Copy link
Member

@ngupta23 ngupta23 commented Feb 12, 2025

  • updated setup instructions/files for a new contributor

@ngupta23 ngupta23 changed the title chore: updates for setup for a new contributor chore: updates setup for a new contributor Feb 12, 2025
@ngupta23 ngupta23 changed the title chore: updates setup for a new contributor chore: updated setup for a new contributor Feb 12, 2025
environment.yml Outdated
@@ -2,6 +2,7 @@ name: utilsforecast
channels:
- conda-forge
dependencies:
- python=3.10
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It states it in the contributing.md. Without this, it creates an env by default using 3.13 when the command is run

image

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am switched the instructions to use uv instead of conda so we can move closer to the current standards. Hope that is fine and will address this comment.

Comment on lines +156 to +158

# VSCode
*.code-workspace
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this could actually be useful if setup correctly

Suggested change
# VSCode
*.code-workspace

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wont people have their individual preferences in this file?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, why would you want to check this into GH unless you want everyone to use VSCode?

settings.ini Outdated
@@ -29,10 +29,10 @@ user = Nixtla
requirements = numpy packaging pandas>=1.1.1
plotting_requirements = pandas[plot] plotly plotly-resampler
polars_requirements = polars[numpy]
dev_requirements = black datasetsforecast==0.0.8 nbdev<2.3.26 numba>=0.58.0 pyarrow scipy
dev_requirements = black datasetsforecast==0.0.8 nbdev<2.3.26 numba>=0.58.0 pyarrow scipy mypy flake8
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've told you several times that these are sorted alphabetically. also we don't need those, we just need pre-commit

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess contributing.md needs to be updated to state that we are using pre-commit in this library. It is not mentioned anywhere in that file.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated to include

  • missing libs from environment.yml and removed environment.yml since it was redundant.
  • pre-commit which was missing originally

@ngupta23 ngupta23 requested a review from jmoralez February 13, 2025 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants