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

added instructions on how to do an editable installation #641

Merged
merged 3 commits into from
Oct 8, 2021
Merged

added instructions on how to do an editable installation #641

merged 3 commits into from
Oct 8, 2021

Conversation

elenajp
Copy link
Contributor

@elenajp elenajp commented Oct 2, 2021

Hi,

I added instructions on how to do an editable installation. Please let me know if you would like me to add more details. I was thinking of writing explanations of what each command does but I was unsure if that was necessary. Thanks for this opportunity, it feels great to be able to contribute to a real project for the first time. I hope what I did was ok.

Elena :)

@elenajp elenajp requested a review from a team as a code owner October 2, 2021 11:23
@binny-the-binary-bear
Copy link

Thank you for contributing to PursuedPyBear! Don't forget to add yourself CONTRIBUTORS.md.

Copy link
Collaborator

@pathunstrom pathunstrom left a comment

Choose a reason for hiding this comment

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

Instructions look good, a few comments to make sure the environment is correct.

Also would like the contributors.md formatting removed just because keeping plain text tables with shared widths is a losing proposition in a community project like this.

Thanks!

CONTRIBUTING.md Outdated
cd ppb-venv
git clone https://github.com/ppb/pursuedpybear.git
cd pursuedpybear
pip install --upgrade -r requirements.txt
Copy link
Collaborator

Choose a reason for hiding this comment

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

This should reference requirements-test.txt instead. The requirements.txt is fed into the setup configuration so you get for free as part of the pip install.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok great, I will make the change. Thanks!

CONTRIBUTORS.md Outdated
[Piper Thunstrom](https://github.com/pathunstrom) | [pathunstrom@gmail.com](mailto:pathunstrom@gmail.com) | [pathunstrom](https://twitter.com/pathunstrom)
[Luna Lunapiena](https://github.com/lunacodes) | [lunacodes@gmail.com](lunacodes@gmail.com) | [lunacodess](https://twitter.com/lunacodess)
[Jamie Bliss](https://github.com/AstraLuma/) | [jamie@ivyleav.es](jamie@ivyleav.es) | [AstraLuma](https://twitter.com/AstraLuma)
| Name | Email | Twitter |
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is a lot of formatting changes, can we revert this file and just add your information?

Trying to keep the nice text format will be a losing game over time regardless of how large we make it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I realised that one of my extensions in vscode was causing the formatting upon saving. I disabled it and will commit again. So the nice format is back :)

@pathunstrom
Copy link
Collaborator

And while we work through the review, I saw you included a twitter account, when we merge, would you like a shoutout from the official twitter?

@elenajp
Copy link
Contributor Author

elenajp commented Oct 3, 2021

And while we work through the review, I saw you included a twitter account, when we merge, would you like a shoutout from the official twitter?

Yeah would would be awesome, thank you 😀

@elenajp
Copy link
Contributor Author

elenajp commented Oct 3, 2021

So the changes have been made. This is my first real contribution to open source so I am getting used to the flow of things on github so I hope everything is ok now. It makes me feel great to be able to contribute! Let me know if I need to make any further changes. Thanks!

Copy link
Collaborator

@pathunstrom pathunstrom left a comment

Choose a reason for hiding this comment

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

Thanks for fixing the formatting thing, I'm sorry our tool chain required that work!

bors r+

@bors bors bot merged commit 2c4cca0 into ppb:canon Oct 8, 2021
@elenajp
Copy link
Contributor Author

elenajp commented Oct 9, 2021

I had fun working on this issue and got to learn more about open source. Thank you! 😀

@elenajp elenajp deleted the e-install branch October 9, 2021 08:14
@pathunstrom
Copy link
Collaborator

I'm glad! Feel free to grab other tickets whenever you like!

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