search

osl-incubator / scicookie

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

fix(pkg): Add project metadata long description (readme) #248

Closed Satarupa22-SD closed 3 months ago

Satarupa22-SD commented 3 months ago

Resolves #240 @xmnlab

xmnlab commented 3 months ago

thanks @Satarupa22-SD for working on that, appreciate that.

I just added a small comment here.

other than that, please run pre-commit install in your scicookie environment and run pre-commit run --all-files to fix the issue that is raising on CI.

for more information, please take a look here: https://osl-incubator.github.io/scicookie/contributing/#setting-up-for-local-development.

note: maybe we would need to discuss a bit more the logo later, check if that works fine with favicon etc .. but for now it looks great. thanks!

Satarupa22-SD commented 3 months ago

@xmnlab I have updated the description.md file.

xmnlab commented 3 months ago

Later we would need to discuss about README.md, docs/index.md and the docs/description.md .. we need to simplify that .. otherwise we will have eventually outdated info for forgetting to update one of these files.

Satarupa22-SD commented 3 months ago

@xmnlab sure :)

github-actions[bot] commented 3 months ago

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

The release is available on:

Your semantic-release bot :package::rocket: