search

rheiland / xml2jupyter

Generate Jupyter widgets (and a notebook) from a PhysiCell XML configuration file
BSD 3-Clause "New" or "Revised" License
8 stars 5 forks source link

Improve contributing guidelines #5

Closed choldgraf closed 5 years ago

choldgraf commented 5 years ago

There are currently fairly minimal contributing guidelines in the README - they mention GitHub issues, but nothing really about how folks can get involved with the project and submit their own pull requests, and there aren't any guidelines helping people navigate the codebase itself (e.g. how it's structured, overview of scripts/modules/etc). For example, here's a contributing file for one of our projects. You don't necessarily need that much information, but some more than just "use github issues" would be helpful.

choldgraf commented 5 years ago

(note, if you don't really want people to contribute development, that's fine too...it's just a bit unclear from the contributing guidelines)

rheiland commented 5 years ago

I tried to clarify and provide a bit more guidance in the "Contributions" section.

choldgraf commented 5 years ago

nice, thanks