Skip to content
This repository has been archived by the owner on May 2, 2024. It is now read-only.

add missing definition of what's a CVE #334

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

Conversation

kirisakow
Copy link

No description provided.

@tricantivu
Copy link

tricantivu commented Jul 19, 2023

Isn't that assumed?

@kirisakow
Copy link
Author

Isn't that assummed?

It may be assumed for you @tricantivu, which doesn't mean it is for everyone out there.

I think the definition is a valuable information and it's a shame it's nowhere to be seen until now.

@tricantivu
Copy link

Isn't that assummed?

It may be assumed for you @tricantivu, which doesn't mean it is for everyone out there.

I am aware of that but how is information one search away valuable?

@kirisakow
Copy link
Author

Firstly, because a properly written introductory README file (just like a legal document or a scientific paper) must be self-sufficient and contain all the definitions with which it operates, or otherwise contain cross-references to external sources that may contain the definitions. That's why I believe the definition belongs here.

Also, one last (and subjective) point: because not giving the definition, and not giving the reason for its absence, is implicitly unsympathetic to anyone who comes to find out what you do. Either the definition should be here, or some statement to explain the reason why it's not.

@tricantivu
Copy link

Firstly, because a properly written introductory README file (just like a legal document or a scientific paper) must be self-sufficient and contain all the definitions with which it operates, or otherwise contain cross-references to external sources that may contain the definitions. That's why I believe the definition belongs here.

Also, one last (and subjective) point: because not giving the definition, and not giving the reason for its absence, is implicitly unsympathetic to anyone who comes to find out what you do. Either the definition should be here, or some statement to explain the reason why it's not.

Fair enough 👍

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

Successfully merging this pull request may close these issues.

None yet

2 participants