ASFHyP3 / hyp3-paper

HyP3 JOSS paper materials
BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

Add contributing infrastructure #3

Closed jhkennedy closed 1 year ago

jhkennedy commented 1 year ago

It'd be nice to have a few things setup to make contributing easier:

forrestfwilliams commented 1 year ago

For workflows, I've identified a spellchecker, a markdown linter, a link checker, and the JOSS pdf builder. I wasn't able to identify a bibtex-specific linter, but there are some latex linters. I'm not sure if these would be appropriate.

jacquelynsmale commented 1 year ago

As for bibtex checkers, there's BibtexNanny and BibLatex-Check. BibLatex-Check isn't under active development but is still functional.

jacquelynsmale commented 1 year ago

@jhkennedy there aren't any pre-built workflows to lint the BibTex file. Is this worth writing our own for or do you think the error message produced if there's something wrong with the bib file during the PDF build will be sufficient?

jhkennedy commented 1 year ago

@jacquelynsmale the PDF build is likely sufficient. Let's mark that task as done indicating it's a won't do and re-open it if we find the PDF build route is not working for us.

forrestfwilliams commented 1 year ago

Contributing guidelines PR is now open.

forrestfwilliams commented 1 year ago

Long term, it would be great if Grammarly supported a GtiHub Action. I've really enjoyed using it for manuscripts in the past.

forrestfwilliams commented 1 year ago

All components are now complete.