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

Docs for contributing code #606

Merged
merged 8 commits into from
Aug 22, 2022

Conversation

MichaelMarien
Copy link
Contributor

@MichaelMarien MichaelMarien commented Aug 18, 2022

Added documentation for getting started with local development and contributing code to DoWhy.
Fixes #528

Open topics I propose to take up later in different PR's:

  • potential issue with notebook execution and testing as this happens in a different virtual environment (base) which might not contain all needed dependencies.
  • add instructions for creating documentation locally (bash scripts are already provided, should be easy).

Topics not touched due to unclarity on my side

  • linting (flake8) and formatting (black, isort): lots of warnings as the current code base is not fully compliant, do we aim so for new contributions and move towards a fully compliant code base? Should any suggestion or requirement towards contributors be included? EDIT: just saw Add formatting check to CI #601 - I'll make a new PR to add formatting instructions later

Signed-off-by: Michael Marien [email protected]

…ntributing code to DoWhy

Signed-off-by: Michael Marien <[email protected]>
Copy link
Member

@amit-sharma amit-sharma left a comment

Choose a reason for hiding this comment

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

This looks great. Thanks @MichaelMarien . I've added some initial comments.

docs/source/contributing/contributing-code.rst Outdated Show resolved Hide resolved
docs/source/contributing/contributing-code.rst Outdated Show resolved Hide resolved
docs/source/contributing/contributing-code.rst Outdated Show resolved Hide resolved
docs/source/contributing/contributing-code.rst Outdated Show resolved Hide resolved
darthtrevino
darthtrevino previously approved these changes Aug 19, 2022
Copy link
Collaborator

@darthtrevino darthtrevino left a comment

Choose a reason for hiding this comment

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

A couple of comments, but otherwise LGTM

docs/source/contributing/contributing-code.rst Outdated Show resolved Hide resolved
docs/source/contributing/contributing-code.rst Outdated Show resolved Hide resolved
docs/source/contributing/contributing-code.rst Outdated Show resolved Hide resolved
docs/source/contributing/contributing-code.rst Outdated Show resolved Hide resolved
@MichaelMarien
Copy link
Contributor Author

I believe I fixed all open requests, let me know if something is still missing.

@MichaelMarien MichaelMarien requested review from darthtrevino and amit-sharma and removed request for darthtrevino and amit-sharma August 21, 2022 12:11
amit-sharma
amit-sharma previously approved these changes Aug 22, 2022
Copy link
Member

@amit-sharma amit-sharma left a comment

Choose a reason for hiding this comment

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

The edits looks great. Approving.

Overall, this is a fantastic resource for developers. Thank you @MichaelMarien for adding this.

@amit-sharma
Copy link
Member

@all-contributors please add @MichaelMarien for doc.

@allcontributors
Copy link
Contributor

@amit-sharma

I've put up a pull request to add @MichaelMarien! 🎉

@amit-sharma amit-sharma merged commit 8aea1fc into py-why:main Aug 22, 2022
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.

Add instructions for setting up a local installation of dowhy for development
4 participants