feat: setup maintainable project #2
Conversation
WilliamBergamin
changed the title
filmaj
left a comment
filmaj
left a comment
There was a problem hiding this comment.
Pretty good! I was able to build/test/run using the instructions.
Would be nice to add the very basics from the maintainers guide to the README. Like, make sure you have python/pyenv installed, and how to run the tests, is probably sufficient to surface in the main README.
seratch
left a comment
seratch
left a comment
There was a problem hiding this comment.
Left a few minor comments. Great work!
.github/workflows/flake8.yml
Outdated
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 20 |
There was a problem hiding this comment.
Does this require such a long time? We can make this as short as possible.
There was a problem hiding this comment.
Good point I've updated all the timeouts
.github/workflows/pytype.yml
Outdated
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 20 |
There was a problem hiding this comment.
I know pytype can take long, but if a shorter duration is enough for this, we can adjust this value to make hunging ones to fail ealier.
pyproject.toml
Outdated
| "ignore:\"@coroutine\" decorator is deprecated since Python 3.8, use \"async def\" instead:DeprecationWarning", | ||
| "ignore:The loop argument is deprecated since Python 3.8, and scheduled for removal in Python 3.10.:DeprecationWarning", |
There was a problem hiding this comment.
If you don't have any asyncio based code, these warnings won't arise
There was a problem hiding this comment.
Good point 💯 removed these filter warnings
scripts/_utils.sh
Outdated
| } | ||
|
|
||
| build() { | ||
| pip install -r requirements/build.txt && \ |
There was a problem hiding this comment.
How about making the indent consistent within this script?
There was a problem hiding this comment.
Good catch 💯
Summary
This PR aims to introduce the necessary files to maintain this project
These change will enable maintainers to
format,test,validateanddeploythe projectNote: a number of these changes were brought from the Bolt and SDK projects
feedback
I'm looking for feedback on