doc: Documentation on setting up the environment by joelrobin18 · Pull Request #719 · graphframes/graphframes · GitHub
Skip to content

doc: Documentation on setting up the environment#719

Merged
SemyonSinchenko merged 3 commits intographframes:mainfrom
joelrobin18:docs/setting_up_environment
Oct 3, 2025
Merged

doc: Documentation on setting up the environment#719
SemyonSinchenko merged 3 commits intographframes:mainfrom
joelrobin18:docs/setting_up_environment

Conversation

@joelrobin18
Copy link
Copy Markdown
Contributor

@joelrobin18 joelrobin18 commented Oct 3, 2025

What changes were proposed in this pull request?

Added a comprehensive Contributing-guide.md file that provides detailed instructions for setting up the project locally for development and testing purposes.

Why are the changes needed?

The project previously lacked documentation on how to set up the development environment locally, run tests, and contribute changes through pull requests. By introducing a comprehensive Contributing-guide.md, we provide step-by-step instructions for environment setup, dependency installation, testing, and the pull request workflow. This would ease the process of contribution for the new contributors.

Signed-off-by: joelrobin18 <joelrobin1818@gmail.com>
Comment thread docs/src/06-contributing/01-contributing-guide.md Outdated
Copy link
Copy Markdown
Contributor

@WeichenXu123 WeichenXu123 left a comment

Choose a reason for hiding this comment

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

LGTM!

Signed-off-by: joelrobin18 <joelrobin1818@gmail.com>
Copy link
Copy Markdown
Collaborator

@SemyonSinchenko SemyonSinchenko left a comment

Choose a reason for hiding this comment

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

At first I want to say thank you for this contribution and interest to the project! I left a few comments, actually there are some easier ways to do some things. And it is my bad that project lacks the good contribution guide :(

Comment thread docs/src/06-contributing/01-contributing-guide.md
Comment thread docs/src/06-contributing/01-contributing-guide.md Outdated
Comment thread docs/src/06-contributing/01-contributing-guide.md
Comment thread docs/src/06-contributing/01-contributing-guide.md
Comment thread docs/src/06-contributing/01-contributing-guide.md
Comment thread docs/src/06-contributing/01-contributing-guide.md Outdated
Comment thread docs/src/06-contributing/01-contributing-guide.md Outdated
@codecov-commenter
Copy link
Copy Markdown

Signed-off-by: joelrobin18 <joelrobin1818@gmail.com>
Copy link
Copy Markdown
Collaborator

@SemyonSinchenko SemyonSinchenko left a comment

Choose a reason for hiding this comment

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

LGTM! Nice work, thank you @joelrobin18 !

@SemyonSinchenko
Copy link
Copy Markdown
Collaborator

@SemyonSinchenko SemyonSinchenko merged commit 609d642 into graphframes:main Oct 3, 2025
5 checks passed
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.

4 participants