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

Replace "Github" with "GitHub" #1532

Merged
merged 1 commit into from
Jan 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ The CVE Binary Tool has a set of tests that can be run using `pytest` command.

We have done our best to make tests stable and ensure that they pass at all times, but occasionally tests may fail due to factors outside your control (common causes: internet connectivity, rate limiting by NVD or new vulnerability data changing our test expectations). If a test doesn't pass, you should look at it to see if any changes you made caused the failure. If you're not sure, submit your code as a pull request and mention the issue and someone will try to help you sort it out.

When you submit your code as a pull request, the whole test suite will be run on windows and linux using the versions of python we support, including longer tests. We don't expect you to do all that yourself; usually trying for one version of python on whatever local OS you have is good enough and you can let Github Actions do the rest!
When you submit your code as a pull request, the whole test suite will be run on windows and linux using the versions of python we support, including longer tests. We don't expect you to do all that yourself; usually trying for one version of python on whatever local OS you have is good enough and you can let GitHub Actions do the rest!

## Running linters

Expand Down Expand Up @@ -266,7 +266,7 @@ Here's a quick checklist to help you make sure your pull request is ready to go:
4. Have I added or updated any documentation if I changed or added a feature?
- New features are often documented in [MANUAL.md](https://github.com/intel/cve-bin-tool/blob/main/doc/MANUAL.md). (See [Making documentation](#making-documentation) for more information.)
5. Have I used [Conventional Commits](https://www.conventionalcommits.org/) to format the title of my pull request?
6. If I closed a bug, have I linked it using one of [Github's keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)? (e.g. include the text `fixed #1234`)
6. If I closed a bug, have I linked it using one of [GitHub's keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)? (e.g. include the text `fixed #1234`)
7. Have I checked on the results from GitHub Actions?
- GitHub Actions will run all the tests, linters and a spell check for you. If you can, try to make sure everything is running cleanly with no errors before leaving it for a human code reviewer!
- As of this writing, tests take less than 20 minutes to run once they start, but they can be queued for a while before they start. Go get a cup of tea or work on something else while you wait!
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ For more details, see our [documentation](https://cve-bin-tool.readthedocs.io/en
- [Output Options](#output-options)
- [Full option list](#full-option-list)
- [Configuration](#configuration)
- [Using CVE Binary Tool in Github Actions](#using-cve-binary-tool-in-github-actions)
- [Using CVE Binary Tool in GitHub Actions](#using-cve-binary-tool-in-github-actions)
- [Binary checker list](#binary-checker-list)
- [Limitations](#limitations)
- [Requirements](#requirements)
Expand Down Expand Up @@ -178,7 +178,7 @@ in the terminal and provide it as an input by running `cve-bin-tool -L pkg-list`
You can use `--config` option to provide configuration file for the tool. You can still override options specified in config file with command line arguments. See our sample config files in the
[test/config](https://github.com/intel/cve-bin-tool/blob/main/test/config/)

## Using CVE Binary Tool in Github Actions
## Using CVE Binary Tool in GitHub Actions

If you want to integrate cve-bin-tool as a part of your github action pipeline.
You can checkout our example [github action](https://github.com/intel/cve-bin-tool/blob/main/doc/how_to_guides/cve_scanner_gh_action.yml).
Expand Down
2 changes: 1 addition & 1 deletion doc/1.0/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Release Date: 20 Apr 2020

This release includes major improvements to the way NVD data is used and
stored. **If you have tried the development tree from Github, you may wish
stored. **If you have tried the development tree from GitHub, you may wish
to run `cve-bin-tool -u now` after you upgrade to remove old data.**

There are now three output formats:
Expand Down
2 changes: 1 addition & 1 deletion doc/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ We are expecting to make some documentation improvements before the final releas
Release Date: 20 Apr 2020

This release includes major improvements to the way NVD data is used and
stored. **If you have tried the development tree from Github, you may wish
stored. **If you have tried the development tree from GitHub, you may wish
to run `cve-bin-tool -u now` after you upgrade to remove old data.**

There are now three output formats:
Expand Down