Making community and contributing guidelines more visible about biopeaks HOT 3 CLOSED

I think these are great suggestions, and on the topic of adding direct links of brief summaries to the README, I might add a note on installation. Some brief info on installation is something I typically expect in the README.

If I'm on Github, I basically just want to know "is this on PYPI". One option is to add a PYPI badge-link to the README (an example of this, and other badges here: https://github.com/neurodsp-tools/neurodsp).

You might also just add a direct link from README -> installation page, and/or a mini section on the README that includes info, even if that's just something like

`biopeaks` can be installed from pypi as
`pip install biopeaks`

For more information on installation, see the documentation page [link]

Note: I'm also from the JOSS review :)

from biopeaks.

@sappelhoff, @TomDonoghue, thanks for your advise and suggestions.

The README now has

• a more prominent link to the documentation
• a short section on installation and corresponding link to more detailled instructions
• a link to the contributor guide

See 7c1d10b.

The contributor guide has been improved with more elaborate instructions (c2092bb).

I did some research on the code of conduct and added one to the repository (884bf6a). The contributor/community aspect was not on my radar so much until now, since the development was mostly a solitary effort so far. But I hope for this to change in the future. Hence I appreciate you bringing the contributor/community aspect to my attention.

from biopeaks.

Excellent, thanks. @TomDonoghue please feel free to re-open in case there were points that you feel have not been addressed.

from biopeaks.