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

Provide DevContainer with tests configured #453

Closed
svrooij opened this issue Jan 15, 2025 · 3 comments · Fixed by #456
Closed

Provide DevContainer with tests configured #453

svrooij opened this issue Jan 15, 2025 · 3 comments · Fixed by #456
Labels

Comments

@svrooij
Copy link
Contributor

svrooij commented Jan 15, 2025

When trying to contribute to this project I'm faced with multiple issues (linting, testing, eg.) that I currently cannot run on my local machine.

It would be super useful if there was a devcontainer configuration and some vscode tasks to do the linting and the checking, that is now only don't in the pipeline. This would greatly help other developers that want to contribute to this project.

@baywet
Copy link
Member

baywet commented Jan 15, 2025

@svrooij I'm not sure what you mean by "not being able to run locally" ??

pip install poetry
cd packageDir
#install the dependencies 
poetry install
# run the linting and fix issues
poetry run yapf -ir packageName
# run the unit tests
poetry run pytest

Let us know if you have any additional comments or questions.

@baywet baywet added Needs: Author Feedback type:question An issue that's a question labels Jan 15, 2025
@baywet baywet moved this from Needs Triage 🔍 to Waits for author 🔁 in Kiota Jan 15, 2025
@svrooij
Copy link
Contributor Author

svrooij commented Jan 16, 2025

This is what I meant... I have no clue about python but this documentation would be useful.

Created a devcontainer config that does this and allows your to run all those things from vscode, no integration with the test extensions, but at least you can run the tests locally.

@baywet
Copy link
Member

baywet commented Jan 16, 2025

That's great! feel free to submit it as a separate PR!

We could also add those instructions to the contributing document for those who prefer not to use dev containers.

svrooij added a commit to svrooij/kiota-python that referenced this issue Jan 17, 2025
Trying to make life easier for new contributors to this project by adding a dev container and additional docs
Fixed Provide DevContainer with tests configured microsoft#453
@github-project-automation github-project-automation bot moved this from Waits for author 🔁 to Done ✔️ in Kiota Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done ✔️
Development

Successfully merging a pull request may close this issue.

2 participants