search

SuffolkLITLab / docassemble-AssemblyLine-documentation

Legal form development and deployment process
https://assemblyline.suffolklitlab.org
8 stars 8 forks source link

Checklist for preparing packages for GitHub #434

Closed samglover closed 2 weeks ago

samglover commented 2 months ago

There is documentation on creating a repository from Docassemble, and a couple of bullet points on naming, but it might be useful to have a bit more of a checklist for preparing Docassemble packages and creating a repository from them. This would help avoid duplicate repos, which we sometimes see.

It would also help to have some more detailed naming guidelines. A suggestion: include an abbreviation for the jurisdiction in the package/repo name to avoid too-similar repository names. For example:

These could be named something like docassemble-MassAffidavitOfIndigency and docassemble-AlaAffidavitOfIndigency for a bit more clarity. (I don't know if Mass. and Ala. are correct for those repos.)

samglover commented 1 month ago

Another suggestion, for READMEs:

# [JURISDICTION] [FORM(S)] This is a Docassemble interview to complete the [JURISDICTION] [FORM(S)] online.

The default README is just a little too hard to read, and authors may not want their names shown publicly (although if they want to, it's fine to leave it in).