cve-bin-tool
cve-bin-tool copied to clipboard
intel
docs: Add tip about `python -m pytest`
- related: https://github.com/intel/cve-bin-tool/issues/3550
In #3550 I mentioned a tip about running pytest as python -m pytest to avoid issues on certain systems where pytest might be installed as a system package. It might be useful to have in our contributor docs.
Note that the bug report in #3550 is really long. Definitely don't include all of that in the docs. I'm looking for 2-3 sentences added to https://github.com/intel/cve-bin-tool/blob/main/CONTRIBUTING.md#running-tests and maybe the same added to the test readme here: https://github.com/intel/cve-bin-tool/blob/main/test/README.md
New Contribution Tips
Short tips for new contributors:
- cve-bin-tool's contributor docs
- If you've contributed to open source but not this project, you might just want our checklist for a great pull request
- cve-bin-tool uses https://www.conventionalcommits.org/ style for commit messages, and we have a test that checks the title of your pull request (PR). A good potential title for this one is in the title of this issue.
- You can make an issue auto close by including a comment "fixes #ISSUENUMBER" in your PR comments where ISSUENUMBER is the actual number of the issue. This "links" the issue to the pull request.
Claiming issues:
- You do not need to have an issue assigned to you before you work on it. To "claim" an issue either make a linked pull request or comment on the issue saying you'll be working on it.
- If someone else has already commented or opened a pull request, assume it is claimed and find another issue to work on.
- If it's been more than 1 week without progress, you can ask in a comment if the claimant is still working on it before claiming it yourself (give them at least 3 days to respond before assuming they have moved on).
@terriko I've submitted I PR 2 days ago, if there is any modification I should make, please let me know. Thanks
