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

Improve naming and be consistent about it #447

Open
sbs2001 opened this issue Apr 22, 2021 · 5 comments
Open

Improve naming and be consistent about it #447

sbs2001 opened this issue Apr 22, 2021 · 5 comments

Comments

@sbs2001
Copy link
Collaborator

sbs2001 commented Apr 22, 2021

Currently we use different terms to describe the same thing
eg safe_package, patched_package, resolved_package .

This should be avoided. We should stick to something once for all.

The https://github.com/nexB/vulnerablecode/blob/fd1572438831ff41cfc856da5d3194b5f2ef825b/vulnerabilities/helpers.py#L124 will also need a good name.
See the comments at #436 for more details

@MUzairS15
Copy link

MUzairS15 commented May 2, 2021

Means wherever we encounter these safe_package, patched_package, resolved_package, we need to replace them. But by which common name, also will it not conflict other parts.? I am new pls guide me.

@pombredanne
Copy link
Collaborator

@MUzairS15 re:

Means wherever we encounter these safe_package, patched_package, resolved_package, we need to replace them. But by which common name, also will it not conflict other parts.?

yes.

The first step is to find the good names alright!

We would need to survey the words used to depict affected/patched in other tools:

  • kaybee/vulas
  • dependencycheck and dependency track (and OWASP)
  • in general all the data source we use
    ...
    with these listed here we can make a good pick together!

@MUzairS15
Copy link

Ok.
So can you tell from where i can start with?

@MUzairS15
Copy link

Scan the whole code make a list and choose one from there and apply changes right?

@pombredanne
Copy link
Collaborator

Scan the whole code make a list and choose one from there...

yes, that would be a start: a survey of the terms used in the external data sources we use in the importers here and some research outside. And posting the results of this research here before we do anything else.

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

No branches or pull requests

4 participants