search

laempy / pyoints

Pyoints: A Python package for point cloud, voxel and raster processing.
Other
42 stars 8 forks source link

[JOSS-REVIEW] Community guidelines missing #3

Closed kbevers closed 5 years ago

kbevers commented 6 years ago

In relation to openjournals/joss-reviews#990

The community guidelines currently consists of these few words under the section "Contact":

In case of questions, suggestions for improvement or software issues, please use    
the issue board or contact Sebastian Lamprecht, lamprecht@uni-trier.de.     
Contribution to the software is always welcome.

While this touches the bare minimum I would appreciate a separate section called "Community" or "Contributing", describing in a bit more words how to contribute to the project either with code or bug reports. GitHub has a nice feature for this in contributing.md files.

laempy commented 5 years ago

@kbevers thank you for the suggestion.

A CONTRIBUTING.md file with some coding conventions has been added. Also some instructions have been moved from README.md to CONTRIBUTING.md.