search

tberlok / paicos

An object-oriented Python package for analysis of (cosmological) simulations performed with Arepo
GNU General Public License v3.0
10 stars 3 forks source link

Further detail in contribution guidelines #47

Closed kyleaoman closed 5 months ago

kyleaoman commented 7 months ago

Suggest fleshing out contribution guidelines a bit - what is the recommended way to install the development version of the package? What is the recommended way to run the test suite locally? Some of this is mentioned in the documentation, linking to those pages as appropriate would make sense.

It would also be useful to include information about expectations from contributors regarding documentations, test coverage, and similar.

tberlok commented 6 months ago

I have updated the guidelines to include these details: https://github.com/tberlok/paicos/blob/main/.github/CONTRIBUTING.md