Skip to content

Commit

Permalink
doc: improve new contributor documentation & readme (#1467)
Browse files Browse the repository at this point in the history 
* fixes: #1465 
* fixes: #1317 
* fixes: #1446
  • Loading branch information
@terriko
terriko committed Dec 29, 2021
1 parent 161aeec commit 1abda79
Show file tree
Hide file tree
Showing 5 changed files with 247 additions and 92 deletions.
22 changes: 13 additions & 9 deletions .github/actions/spelling/allow.txt
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
refactoring
peb
conventionalcommits
nisamson
bhargavh
jerinjtitus
Molkree
Romi
abhaykatheria
ableabhinav
accountsservice
Expand All @@ -21,6 +13,7 @@ api
apk
Args
asn
asottile
autoescape
autoextract
autoextracts
Expand All @@ -32,6 +25,7 @@ bcca
bdbd
bdist
bestpractices
bhargavh
bigbird
binutils
bksahu
Expand Down Expand Up @@ -60,6 +54,7 @@ cmdline
codecov
conda
config
conventionalcommits
copyleft
coreinfrastructure
cpio
Expand Down Expand Up @@ -90,6 +85,7 @@ distros
dnsmasq
docstring
DOCTYPE
downloading
dpkg
dsa
dtls
Expand Down Expand Up @@ -157,6 +153,7 @@ INI
irssi
itertools
javascript
jerinjtitus
jquery
json
Kamdar
Expand Down Expand Up @@ -194,6 +191,7 @@ libxml
libxslt
lifecycle
lighttpd
linting
linux
logrotate
lua
Expand All @@ -211,6 +209,7 @@ metadata
microsoft
mkdir
modulename
Molkree
mozilla
msgid
msgstr
Expand All @@ -226,6 +225,7 @@ netpbm
nginx
Niraj
nirajkamdar
nisamson
nitishsaini
nlk
noopener
Expand All @@ -252,6 +252,7 @@ pcsc
pdf
pdftotext
pdxjohnny
peb
php
pigz
plotly
Expand All @@ -272,6 +273,7 @@ pypi
pytest
pythex
pythonapp
pyupgrade
Qqe
queryformat
quickstart
Expand All @@ -281,8 +283,9 @@ Rahul
readme
readthedocs
realpython
downloading
refactoring
regex
Romi
rossburton
rpmfile
rst
Expand All @@ -295,6 +298,7 @@ sbs
sdk
shreyamalviya
somefile
sottile
SPDX
sqlite
src
Expand Down

1 comment on commit 1abda79

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented on 1abda79 Dec 29, 2021 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@check-spelling-bot Report

Unrecognized words, please review:

  • filetype
To accept these unrecognized words as correct, run the following commands

... in a clone of the git@github.com:intel/cve-bin-tool.git repository
on the main branch:

update_files() {
perl -e '
my $new_expect_file=".github/actions/spelling/expect.txt";
use File::Path qw(make_path);
use File::Basename qw(dirname);
make_path (dirname($new_expect_file));
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"$patch_add"');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a)."-".$a cmp lc($b)."-".$b} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;
system("git", "add", $new_expect_file);
'
}

comment_json=$(mktemp)
curl -L -s -S \
  --header "Content-Type: application/json" \
  "https://api.github.com/repos/intel/cve-bin-tool/comments/62660652" > "$comment_json"
comment_body=$(mktemp)
jq -r .body < "$comment_json" > $comment_body
rm $comment_json

patch_add=$(perl -e '$/=undef;
$_=<>;
s{<details>.*}{}s;
s{^#.*}{};
s{\n##.*}{};
s{(?:^|\n)\s*\*}{}g;
s{\s+}{ }g;
print' < "$comment_body")
  
update_files
rm $comment_body
git add -u

Please sign in to comment.