osl-incubator / scicookie

Cookiecutter template for a Python package.
https://osl-incubator.github.io/scicookie
Other
11 stars 18 forks source link

Update local development setup instructions in CONTRIBUTING.md and template #204

Closed Naman-Priyadarshi closed 5 months ago

Naman-Priyadarshi commented 5 months ago

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 Blocks Fixed Issue in template where instructions said tox and flake8 but referenced make lint and make 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:

## Reviewer's Checklist

- [ ] I managed to reproduce the problem locally from the `main` branch
- [ ] I managed to test the new changes locally
- [ ] I confirm that the issues mentioned were fixed/resolved
Naman-Priyadarshi commented 5 months ago

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!

github-actions[bot] commented 4 months ago

:tada: This PR is included in version 0.7.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: