geodynamics / best_practices

Software development and training best practices.
13 stars 9 forks source link

Version Control: Require public repository accessible without registration to align with JOSS #21

Closed baagaard-usgs closed 1 year ago

baagaard-usgs commented 2 years ago

Update the minimum Best Practices for version control to reflect current practices and better align with the Journal of Open-Source Software (JOSS) acceptable practices. I recommend an explicit requirement of Git because it is the current standard.

Replace

Use of version control (e.g., subversion, git) to manage code changes

with

Use a Git repository to manage code changes. The Git repository must be publicly accessible without registration.

ljhwang commented 2 years ago

I agree that specifying a publicly accessible (open source) repository would add clarity to policy. However, I am hesitant in adding prescriptive requirements to policy. In the long form of the BP we give Git has an example. Maybe we should clean this up.

baagaard-usgs commented 2 years ago

Replace

Use of version control (e.g., subversion, git) to manage code changes

with

Use a public repository that is accessible without registration, such as GitHub, GitLab.

ljhwang commented 2 years ago

I think this works in combination with our licensing requirements to use an open source license. See also: https://openweaver.medium.com/beware-over-half-of-the-github-public-repositories-are-not-open-source-licensed-23c7d2b5b621

gassmoeller commented 1 year ago

Closed by #26.