Github Governance

This readme is for building out our github gonvernance.

Top level SWRCB GitHub Documentation that covers our guiding principals, protocols, management decisions, and policies

Also, this is open to discussion.

Things that might go in this documnet or in this repo:

1. Data Governanace guiding pricipals and documents
   1. A code of conduct possibily this one
   2. Open data policy documentation
      1. CHHS has a Open Data Handbook we might considering forking or adopting in all or part. Their githubpage
   3. F(findable) A(accessible) I(interoperable) R(reusable)
2. Github account management, repo administration,
   1. Default Account permissions for WaterBoard members and outside collaborators
   2. You can define which individuals or teams own certain types or areas of code in a CODEOWNERS file.
   3. Other ideas to implement
      1. Contributing guidlines for internal/external collaborators possibly this one
      2. Justification for creation of Repos
      3. Actions to be taken after the creation of repos.
3. GitHub Wiki
   1. NOAA NMFS's Openscapes org - the gathering place for NOAA open science use rather than the actual guidelines (e.g., see the different licenses used)
   2. Other guidelines - NOAA
   3. We also have open source guidelines from the college of water informatics which might be helpful.
4. Data Ethical documentation
   1. Data ethics stuff: GovOps wrote a Medium article on Data Ethics
   2. Fed ethics framework is one they mention
   3. FAIR and CARE principles resources are all over the place
   4. Here are another couple of things I found that is worth researching
   5. CPTF eval toolkit
5. GitHub useful links an guidlines
   1. github skills
   2. openscapes git clinic
   3. Github workflows -
      1. a section on conventions for commit messages and pull requests.
      2. templates/resources/suggestions for project organization and workflow - likely something we customize, or adopt from existing resources
         1. AP Datakit is a somewhat generic tool (with separate templates for python, R, and generic projects)
         2. the workflowr package is an R-specific resource.
   4. others?

Other considerations

1. Data standards might live here or get moved to another location
   1. Water Data formats
      1. Water Data Consortium's urban supplier data format
      2. WaDE 2. 0 -- The next version of the Water Data Exchange (WaDE) program. An agreed upon metadata standard and information system for sharing water budget data in the US. Water budgets data include site specific and aggregated water rights, water supplies, use, return flows, and transfers at geospatial areas.
2. Data use licenses Open Sources Licenses
   1. Creative commons
   2. MIT
   3. atribution
   4. Apache
   5. BSD
   6. other relevant licenses pre-approved for WB use?
3. Coding style guidance
   1. It might be worth pointing to some suggested coding style guides - e.g., for R a good one might be the tidyverse style guide.
   2. Related tools for checking and/or reformatting code - e.g., for R the styler and lintr packages