NASA-PDS/template-repo-python

Improvements to template repo

Closed this issue · 8 comments

jordanpadams commented

Some additional improvements to python template repo. Almost there, but a few more things I think could help wrap this up.

  • Add a template "Hello World"-like doc source page so the sphinx docs can be built via CI/CD
  • Create a Github Pages branch to push the docs to as part of CI/CD
  • #18
  • #7
  • Update stable_cicd.yaml to use latest roundup (e.g. triggered by release/* branch)
  • Add CONTRIBUTOR guide - github says some things here but open to something apache-like
  • Add CODE_OF_CONDUCT - example from some SMD folks, but open to something apache-like
MJJoyce commented

@nutjob4life / @jordanpadams, thoughts on adding a default code formatter (e.g., black) and linter (e.g., flake8)?

I've had good luck using those with minor configuration changes to get automatic code formatting / linting, along with test suite execution, etc., with git hooks. I like to use pre-commit since it mildly simplifies managing the installation of stuff. Takes pretty much all the guess work / personal opinion out of formatting stuff during code reviews.

  • 👍1
jordanpadams commented

@MJJoyce I like the idea, but I'll leave it to @tloubrieu-jpl and @nutjob4life to make the call

  • 👍1
MJJoyce commented
  • Add a template "Hello World"-like doc source page so the sphinx docs can be built via CI/CD

A default index.html file is built as part of the current docs build. Are we looking for something more complicated than that?

Potential solution to cover these in all of our repositories here:
NASA-PDS/pds-github-util#15 (comment)

Not sure how folks feel about that.

MJJoyce commented
  • Update stable_cicd.yaml to use latest roundup (e.g. triggered by release/* branch)

I think this was covered by @nutjob4life with 68e433f? Sean can you confirm?

nutjob4life commented

thoughts on adding a default code formatter (e.g., black) and linter (e.g., flake8)?

So long as we can have 120 columns I'm all for it. But let's make it part of the PDS Style Guide epic. I think keeping this ticket a bit more tightly focused means we'll be able to get it done with the limited time you (and me) can devote to PDS work.

I think this was covered by @nutjob4life with 68e433f? Sean can you confirm?

Confirmed! (Now … does it actually work? I think so!)

  • 👍1
MJJoyce commented
  • Add a template "Hello World"-like doc source page so the sphinx docs can be built via CI/CD

Calling the above done since our docs build outputs an index file that (IMO) covers this.

@nutjob4life / @jordanpadams / @tloubrieu-jpl, thoughts on the potential solution here:
NASA-PDS/pds-github-util#15 (comment)

TLDR: Make nasa-pds/.github, add the default versions of these files, and Github will allegedly make sure they show up in every repo that doesn't specify one. Seems like a painless way to make sure we always have these files around.

  • 👀1
MJJoyce commented

Code of Conduct and Contributor guides are being handled in:
https://github.com/NASA-PDS/.github

MJJoyce commented

Defaults for Code of conduct and Contributor guides have been added to the org-wide default repo