Repository navigation
Add in a GENERAL_INFO.md document? #37
Description
We should maybe add some sort of file in the top level for general information, etc. like:
-
versioneerusage and set up -
pre-commitset up - GHA and secrets information
- how to set up
gh-pagesbranch - links to Wikis and other repos for demos
- setting up
condaforge-feedstockand auto-merge (xref Automated merging for conda-forge feedstock #31) - other stuff – PLEASE ADD TO LIST!!!
Maybe a file like GENERAL_INFO.md, where we make it clear that the file should be deleted when setting up an actual repo.
Activity
knaaptime commentedon Dec 2, 2022
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 commentedon Dec 2, 2022
Seems like a reasonable idea.
martinfleis commentedon Dec 2, 2022
I would personally update https://pysal.org/docs/devs/ with such an info rather than creating another place for it.
knaaptime commentedon Dec 2, 2022
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 commentedon Dec 2, 2022
I don't mind where is it, but agree that there should be only one source of truth. Could be here.