search

devnums / pyheartlib

A Python package for processing electrocardiogram signals ❤️
https://pyheartlib.readthedocs.io/
GNU Affero General Public License v3.0
2 stars 1 forks source link

add more information to the contribution guidelines #8

Closed LegrandNico closed 1 year ago

LegrandNico commented 1 year ago

The contribution guidelines could be detailed, adding for example instructions on how to contribute to the documentation and run the tests. Using a public platform for questions and help is probably preferable over email exchanges (also for the maintainer).

See this example of guidelines from another popular repository here.

This issue is related to the review of the package for JOSS (see here).

devnums commented 1 year ago

Thanks for your comment. The file has been updated. Please check it on the branch: paper contributing.md

LegrandNico commented 1 year ago

It looks like the discord link is broken, maybe this could be removed?

devnums commented 1 year ago

You are right, I have created a new permanent link. CONTRIBUTING.md