search

osl-incubator / scicookie

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

Incorrect Setup Instructions in CONTRIBUTING for Local Development #203

Closed Naman-Priyadarshi closed 5 months ago

Naman-Priyadarshi commented 5 months ago

Summary

Overview

The current setup instructions provided in the CONTRIBUTING.md for local development are outdated and incorrect. The instructions suggest using python setup.py develop for installation, but the setup.py file does not exist in the repository. This issue could also help in fixing the CONTRIBUTING.md in the template too

Proposed Solution:

Update the CONTRIBUTING file with accurate and up-to-date instructions for local development. This may involve recommending alternative methods for installation, such as using Poetry poetry install or pip pip install -e ..

Documentation Page Link

https://osl-incubator.github.io/scicookie/contributing.html#get-started

Code of Conduct

Saransh-cpp commented 5 months ago

Yes, the documentation is really out of date. Thanks for pointing this out!

github-actions[bot] commented 4 months ago

:tada: This issue has been resolved in version 0.7.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: