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

Enhance the requirements setup and add a basic contributing guide #175

Merged
merged 5 commits into from
Nov 25, 2021

Conversation

greyli
Copy link
Contributor

@greyli greyli commented Nov 15, 2021

This PR continues #153, as I addressed in that PR:

By the way, I think these requirements should only list dev dependencies, if you agree, I will update them to remove the repeat dependencies that are already defined in the setup.py. Since we normally use the following commands to start to develop the project:

pip install -e .
pip install -r requirements/dev.txt

So this PR implemented that proposal:

  • Remove the dependencies that already defined in setup.py install_requires
  • Split requirements into dev/example/test
  • Update the GitHub workflows

This PR also adds a simple contributing section to the README, while a complete contributing guide like this one for Nebula Graph should be added in the future. If you think the contributing section is not needed now, just remove it.

If you think the current requirements setup is good enough, feel free to close this PR.

This is the last improvement for nebula-python in my todo-list. Thank you and bye!

greyli and others added 5 commits November 15, 2021 12:06
- Remove the dependencies that already defined in setup.py install_requires
- Split requirements into dev/example/test
- Update the GitHub workflows
@Aiee
Copy link
Contributor

Aiee commented Nov 25, 2021

Hi, @greyli
Thank you again for bringing these good practices to Nebula python. Looking forward see you around!

@Aiee Aiee merged commit 3f05be5 into vesoft-inc:master Nov 25, 2021
@greyli greyli deleted the requirements-enhance branch November 25, 2021 09:31
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.

2 participants