DEV: setting up vscode workspace

[Gui-FernandesBR]

Pull request type

• Other (please describe): development tool!

Checklist

• Tests for the changes have been added (if needed)
• Docs have been reviewed and added / updated
• Lint (black rocketpy/ tests/) has passed locally
• All tests (pytest tests -m slow --runslow) have passed locally
• CHANGELOG.md has been updated (if relevant)

Current behavior

Most of our developers use Visual Studio Code as their development workspace.
However, VScode allows you to change several configurations, which may be a challenge for new developers.
It would be nice if we standardize some of basic configurations across the team.

New behavior

• Removed vscode files from the gitignore (please check if it doesn't conflict with you local file!!
• Added custom words to the cSpell dictionary (in the future I want to add a simple test that checks for typos, so it is important that we actually maintain this dictionary)
• Added recommended extensions (as the name said, it is only a recommendation, so it won't be installed when cloning the repo).
• I fixed some simple "typos" but didn't spend much time on that. This is something we can

These configurations will be used symbiotically along with your "user settings", therefore no conflicts or errors should be expected. It's just a matter of "guiding" new devs with useful recommendations.

Breaking change

• No

Additional information

This is another step on the "making developers' lives easier" journey.

Refs:

• https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions

[codecov]

Codecov Report

Attention: Patch coverage is 33.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 73.85%. Comparing base (44cd770) to head (4de2918).
Report is 1 commits behind head on develop.

Files	Patch %	Lines
rocketpy/mathutils/function.py	0.00%	1 Missing ⚠️
rocketpy/simulation/monte_carlo.py	50.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##           develop     #633   +/-   ##
========================================
  Coverage    73.85%   73.85%           
========================================
  Files           70       70           
  Lines        10035    10035           
========================================
  Hits          7411     7411           
  Misses        2624     2624           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Lucas-Prates]

Very good PR, certainly helps a lot to have uniform tools across the team! One thing, though: do you also have custom configurations for black/flake8? I recall someone suggesting flake8 args, but I forgot it 😬.

[Gui-FernandesBR]

Very good PR, certainly helps a lot to have uniform tools across the team! One thing, though: do you also have custom configurations for black/flake8? I recall someone suggesting flake8 args, but I forgot it 😬.

@Lucas-Prates Thank you for your comment!

The customized pylint rules are defined in the .pylintrc file, in the root directory.
The black, isort and flake8 configurations are already done in the pyproject.toml file.
Therefore you should no longer be concerned with customizing these tools when working in this repository.

[Gui-FernandesBR]

Requesting re-review from you @MateusStano @Lucas-Prates .
I'm assuming you've checked out the branch and tested in your machine without any conflicts.

Once again... recommendations are simply recommendations. If you don't want to use a certain extension, you just don't download it.

[MateusStano]

Seems good

I noticed that the spell checker does not analyze notebooks unless you open them, so there are a few words there that are not included in the exceptions.

I don't know if you intended notebooks to be included in the checking though, so I am approving the PR here