pysal / submodule_template

This provides a template for submodules to use in the PySAL project
BSD 3-Clause "New" or "Revised" License
2 stars 10 forks source link

Add in a `GENERAL_INFO.md` document? #37

Open jGaboardi opened 1 year ago

jGaboardi commented 1 year ago

We should maybe add some sort of file in the top level for general information, etc. like:

Maybe a file like GENERAL_INFO.md, where we make it clear that the file should be deleted when setting up an actual repo.

knaaptime commented 1 year ago

yeah, and it should probably replace https://pysal.org/docs/devs/ with the latest conventions (and maybe we leave this kinda developer documenting to here instead of the website so we dont get competing resources?)

jGaboardi commented 1 year ago

yeah, and it should probably replace https://pysal.org/docs/devs/ with the latest conventions (and maybe we leave this kinda developer documenting to here instead of the website so we dont get competing resources?)

Seems like a reasonable idea.

martinfleis commented 1 year ago

I would personally update https://pysal.org/docs/devs/ with such an info rather than creating another place for it.

knaaptime commented 1 year ago

Agree we should have a single source, but i'd rather re-canonize it here. To me, the website feels like a place for users more than developers, whereas the submodule contract is where it makes more sense to house the 'dev set up' instructions.

Right now both the submodule template and the website contain competing instructions, so i vote here rather than there. Tbh, i forget the website instructions even exist--but maybe thats just me. No worries if im outvoted

martinfleis commented 1 year ago

I don't mind where is it, but agree that there should be only one source of truth. Could be here.