Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add clarification to version control #40

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kaitj
Copy link
Collaborator

@kaitj kaitj commented May 6, 2024

This PR adds a clarification to the version control - that is some traceable history (e.g. commit hash, version tag, etc.) I tried to keep this in a similar style to other clarification points.

- Added to both schema.json (what is rendered on the website) and the checklist.json
@kaitj kaitj mentioned this pull request May 6, 2024
3 tasks
@shnizzedy
Copy link
Member

What's the anticipated confusion this clarification is meant to clear up?

Maybe I'm being dense, but I think "version control" is a pretty widely understood term in the context of software and "traceable history" is a little more vague?

Instead of

i.e., traceable history of changes; e.g. commit hash, version tags

could something as simple as

e.g., git or Apache Subversion

suffice?

@kaitj
Copy link
Collaborator Author

kaitj commented Aug 6, 2024

I can't recall where the potential confusion stemmed from. I think your suggestion would probably suffice, or could potentially just leave as is unless it gets brought up during actual use now that I am looking at this again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants