-
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
Update local development setup instructions in CONTRIBUTING.md and template #204
Update local development setup instructions in CONTRIBUTING.md and template #204
Conversation
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.
Thanks for taking this up, @Naman-Priyadarshi! A few comments below -
…structions' into update-local-dev-instructions
I have resolved the changes. Also, I replaced the flake8 and tox step with adding a pre-commit section. Let me know how it looks! |
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.
Looks good, thanks @Naman-Priyadarshi!
🎉 This PR is included in version 0.7.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Pull Request description
This pull request updates the CONTRIBUTING file for scicookie and the template to provide accurate and up-to-date instructions for setting up the project locally. The previous instructions were outdated and misleading, as they referenced a setup.py file that does not exist in the repository.
Changes Made:
Updated the CONTRIBUTING.md with clear and concise instructions for local development setup.
Removed references to the nonexistent setup.py file.
Provided alternative installation methods such as Poetry (poetry install) and pip (pip install -e .).
Replaced
$
with Code BlocksFixed Issue in template where instructions said tox and flake8 but referenced
make lint
andmake tests
Fixes #203
How to test these changes
...
Pull Request checklists
This PR is a:
About this PR:
Author's checklist:
Additional information
Reviewer's checklist
Copy and paste this template for your review's note: