-
Notifications
You must be signed in to change notification settings - Fork 18
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
[CI] Enable CI and setup all logistics #14
Conversation
- name: Install dependencies | ||
run: poetry install | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note @darthtrevino there is no way that I am aware of to only install what's needed for running the style checks. This ends up installing all dependencies right?
I think there is a fix coming up in v1.2 for poetry, but for now, I suppose this is fine since reading more, poetry does have a lot of nice properties.
acd7af0
to
956720f
Compare
Signed-off-by: Chris Trevino <chtrevin@microsoft.com> Signed-off-by: Adam Li <adam2392@gmail.com>
Signed-off-by: Chris Trevino <chtrevin@microsoft.com> Signed-off-by: Adam Li <adam2392@gmail.com>
Signed-off-by: Chris Trevino <chtrevin@microsoft.com> Signed-off-by: Adam Li <adam2392@gmail.com>
Signed-off-by: Chris Trevino <chtrevin@microsoft.com> Signed-off-by: Adam Li <adam2392@gmail.com>
Signed-off-by: Adam Li <adam2392@gmail.com>
First step for #11
Summary for CI
We should keep CI and setup and installation workflow relatively similar. From my exp in OSS, this alleviates developer burden and overall technical debt.
This PR adds additional checks to the CI that are based off best practices:
main
branchTODO for CI:
Summary for repo docs
I've added more details to the README based on my experience. What would be nice is to extend the main figure in dowhy's README to encompass causal discovery. Otw, I think short READMEs are the way to go and then linking to the documentation.
Summary for code documentation
I've uploaded boiler plate documentation that will leverage the pydata sphinx layout. Inside we should track: contributors, and PRs. The API is also auto-rendered here via sphinx.
cc: @robertness