search

DavidLapous / multipers

Python library for multipersistence
https://davidlapous.github.io/multipers/
MIT License
15 stars 2 forks source link

Contributor instructions #19

Closed peekxc closed 1 month ago

peekxc commented 2 months ago

Per the JOSS standard, there should be some community guidelines regarding contribution, reporting issues, etc. The examples in the package are great, but I didn't find either a CONTRIBUTING.md or a doc page akin to this giving such instructions.

@DavidLapous Could you add one of the above to the repo, or show me where one already exists? It would help potential contributors immensely!

6773

DavidLapous commented 2 months ago

Dear @peekxc, thanks for noticing it. The current contribution text is a bit short indeed, at the end of the readme. I've added templates for bug reports / feature requests in the commits 0e4878461ae0286efea39aa0f6e6325f9e8c61c7 and 2d7287612a494eb0ebfb922c1803a48187089d73 to (hopefully) have better generic issues in the future. You can check that by trying to open an issue. I'll add a contributing page in the documentation for the next release.

DavidLapous commented 2 months ago

I've added a contributions page in the doc here. I still need to do a release to ensure that doc<->library are coherent, but this point should be fixed.

peekxc commented 1 month ago

Thanks @DavidLapous! Looks good