Skip to content

Commit 54e63a6

Browse files
committed
fix typos in project files
Signed-off-by: Vishesh Garg <[email protected]>
1 parent d92ed73 commit 54e63a6

File tree

8 files changed

+39
-39
lines changed

8 files changed

+39
-39
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ AboutCode is a family of FOSS projects to uncover data ... about software:
77
- where does the code come from? which software package?
88
- what is its license? copyright?
99
- is the code vulnerable, maintained, well coded?
10-
- what are its dependencies, are there vulneribilities/licensing issues?
10+
- what are its dependencies, are there vulnerabilities/licensing issues?
1111

1212
All these are questions that are important to answer: there are millions of free
1313
and open source software components available on the web for reuse.
@@ -61,13 +61,13 @@ Each AboutCode project has its own repository:
6161
- **[Scancode.io](https://github.com/aboutcode-org/scancode.io)**: is a
6262
web-based and API to run and review scans in rich scripted pipelines, on
6363
different kinds of containers, docker images, package archives, manifests
64-
etc, to get information on licenses, copyrights, source, vulneribilities.
64+
etc, to get information on licenses, copyrights, source, vulnerabilities.
6565
The lead maintainer is @tdruez
6666

6767
- **[VulnerableCode](https://github.com/aboutcode-org/vulnerablecode)**: is a
6868
web-based API and database to collect and track all the known software
6969
package vulnerabilities, with affected and fixed packages, references and a
70-
standalone tool Vulntotal to compare this vulneribility information across
70+
standalone tool Vulntotal to compare this vulnerability information across
7171
similar tools. This is maintained by @tg1999 and @pombredanne
7272

7373
- **[univers](https://github.com/aboutcode-org/univers)** is a package to

docs/source/aboutcode-data/abcd.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ Each of these objects has a few identifying attributes and eventually
193193
many tool- or application-specific data attributes. Each tool defines
194194
and documents the attributes they can handle and care for. When some
195195
agreement is reached on the definition of new attributes or objects, the
196-
ABCD dictionary may be updated accordingly with new objects types such
196+
ABCD dictionary may be updated accordingly with new object types such
197197
as for software security, quality or other interesting aspects.
198198

199199
Objects are interrelated with other objects. Objects can relate to each
@@ -226,7 +226,7 @@ process the known objects and attributes.
226226
- Attributes are name/value pairs.
227227

228228
- Attribute names are always strings, not numbers, not booleans, not any
229-
other data format. In these strings, leading and trailing white spaces
229+
other data format. In these strings, leading and trailing whitespace
230230
(spaces, tabs, line returns, etc) are not significant and can be safely
231231
ignored or removed.
232232

@@ -254,7 +254,7 @@ Name conventions
254254
underscores. Names cannot start with a number. Names cannot contain
255255
spaces nor other punctuation, not even a dot or period.
256256

257-
- Names are NOT case sensitive: upper or lowercase does not matter and
257+
- Names are NOT case-sensitive: upper or lowercase does not matter and
258258
the standard is to use lowercase. It is a mistake to use upper or
259259
mixed case but this is something a parser receiving ABC Data should
260260
recover from nicely by converting the names to lowercase.
@@ -413,7 +413,7 @@ for the value type or meaning:
413413
is about some status.
414414

415415
- xxx_name: such as short_name. Indicates that the value is a name.
416-
Commonly used for long_name, short_name. The bare name shout be
416+
Commonly used for long_name, short_name. The bare name should be
417417
preferred for the obvious and most common way an object is named.
418418

419419
- xxx_flag, is_xxx, has_xxx: such as is_license_notice. Indicates
@@ -462,7 +462,7 @@ The minimal way to identify top level objects is the combination of a
462462
implicit when two parties are exchanging data privately or explicit
463463
using the "source" attribute.
464464

465-
Within a source, we use the most obvious and natural identifies for an
465+
Within a source, we use the most obvious and natural identifiers for an
466466
object. For example:
467467

468468
- For Products, Components and Packages we can use their name and
@@ -834,7 +834,7 @@ writing primarily by humans.
834834
separators).
835835

836836
- Beware of parser shenanigans: Most YAML parsers recognize and convert
837-
automatically certain data types such as numbers, booleans or dates.
837+
automatically certain data types such as numbers, booleans, or dates.
838838
You should be aware of this because the ABC Data strings may contain
839839
date stamps. You may want to configure a YAML parser to deactivate some
840840
of these automated format conversions to avoid unwanted conversions.
@@ -920,7 +920,7 @@ mappings to ABC Data attribute and object names.
920920
Since ABC Data can be related by reference, the preferred (and
921921
cumbersome) way to store ABC Data in a spreadsheet is to use one tab for
922922
each object type and use identifying attributes to relate objects
923-
between each others across tabs. For instance, in a Bill of Materials
923+
between each other across tabs. For instance, in a Bill of Materials
924924
(BOM) spreadsheet for a Product, you could use a tab to describe the
925925
Product attributes and another tab to describe the Components used in
926926
this Product and possibly additional tabs to describe the related
@@ -930,7 +930,7 @@ packages and files corresponding to these
930930
versions, unicode and UTF-8 to avoid damaging content (aka. mojibake)
931931

932932
Spreadsheet tools such as Excel or LibreOffice  automatically recognize
933-
and convert data to their own format: a date of 20016-08-17 may be
933+
and convert data to their own format: a date of 2016-08-17 may be
934934
converted to a date number when a CSV is loaded and difficult to recover
935935
as a correct original date stamp string afterwards. Or a version 1.0 may
936936
be irreversibly converted to 1 or 1.90 to 1.9 losing important version

docs/source/archive/contributor_project_ideas.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ AboutCode is a project to uncover data ... about software code:
1313

1414

1515
* where does the code come from? which software package?
16-
* what's is its license? copyright?
16+
* what is its license? copyright?
1717
* is the code secure, maintained, well coded?
1818

19-
All these are questions that are important to find answers to: there are million
19+
All these are questions that are important to find answers to: there are millions
2020
of free and open source software components available on the web.
2121

2222
Knowing where a software package comes from, if it is vulnerable and what's its
@@ -28,7 +28,7 @@ more free and open source software.
2828
Our tools are used to help detect and report the origin and license of source
2929
code, packages and binaries as well as discover software and package
3030
dependencies, and track security vulnerabilities, bugs and other important
31-
software package attributes. This is a suite of command line tools, web-based
31+
software package attributes. This is a suite of command-line tools, web-based
3232
and API servers and desktop applications.
3333

3434
Table of Contents
@@ -250,13 +250,13 @@ The features and TODO for this updated server would be:
250250
* Aggregate more and new packages vulnerabilities feeds,
251251

252252
* Automating correlation: add smart relationship detection to infer new
253-
relatiosnhips between available packages and vulnerabilities from mining the
253+
relationships between available packages and vulnerabilities from mining the
254254
graph of existing relations.
255255

256256
* Create a ScanCode plugin to report vulnerabilities with detected packages
257257
using this data.
258258

259-
* Integrate API lookup on the server withe the AboutCode Manager UI
259+
* Integrate API lookup on the server with the AboutCode Manager UI
260260

261261
* Create a UI and model for community curation of vulnerability to package
262262
mappings, correlations and enhancements.
@@ -474,7 +474,7 @@ Copyright detection is the slowest scanner in ScanCode. It is based on NLTK part
474474
of speech tagging and a copyright grammar.
475475

476476
The goal of this project is to refactor Copyright detection for speed and
477-
simplicity possibly implementaing a new parser (PEG?, etc) or reimplementing
477+
simplicity possibly implementing a new parser (PEG?, etc) or reimplementing
478478
core elements in Rust with a Python binding.
479479

480480
This would include also keeping track of line numbers and offsets where copyrights are found.
@@ -549,7 +549,7 @@ to effectively support proper inventory of installed packages without running
549549
the containers.
550550

551551
This includes determining which packages are installed in Docker layers for
552-
RPMs, Debian or Alpine Linux. And this woudl eventually require the integration
552+
RPMs, Debian or Alpine Linux. And this would eventually require the integration
553553
of ScanCode.
554554

555555

@@ -580,7 +580,7 @@ TraceCode does system call tracing only today.
580580
- This project also would cover updating TraceCode to use the Click comamnd line toolkit
581581
(like for ScanCode).
582582

583-
- Finally thsi project should improve the tracing of the lifecycle of file
583+
- Finally this project should improve the tracing of the lifecycle of file
584584
descriptors in TraceCode build. We need to improve how TraceCode does system
585585
call tracing by improving the way we track open/close file descriptors in the
586586
trace to reconstruct the lifecycle of a traced file.
@@ -642,7 +642,7 @@ This requires a good understanding of packaging and Python.
642642
**Package URL implementations in many programming languages**
643643
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
644644

645-
We have a purl implmentation in Python, Go and possibly Java today.
645+
We have a purl implementation in Python, Go and possibly Java today.
646646

647647
The goal of this project is to create multiple parsers and builders in several
648648
programming languages:

docs/source/archive/gsoc/org_pages/gsoc_2017.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ relevant:
7171
* Detailed description of your idea including explanation on why is it innovative and what it will
7272
contribute
7373

74-
* hint: explain your data structures and the main processing flows in details.
74+
* hint: explain your data structures and the main processing flows in detail.
7575

7676
* Description of previous work, existing solutions (links to prototypes, bibliography are more
7777
than welcome)

docs/source/archive/gsoc/org_pages/gsoc_2019.rst

+11-11
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Google Summer of Code 2019
44
==========================
55

66
AboutCode is participating in the Google Summer of Code in 2019 as a mentoring org. This page
7-
contain all the information for students and anyone else interested in helping.
7+
contains all the information for students and anyone else interested in helping.
88

99
AboutCode is a family of FOSS projects to uncover data ... about software code:
1010

@@ -13,7 +13,7 @@ AboutCode is a family of FOSS projects to uncover data ... about software code:
1313
- what is its license? copyright?
1414
- is the code secure, maintained, well coded?
1515

16-
All these are questions that are important to answer: there are million
16+
All these are questions that are important to answer: there are millions
1717
of free and open source software components available on the web for reuse.
1818

1919
Knowing where a software package comes from, what is its license and if it is
@@ -420,11 +420,11 @@ DeltaCode projects
420420
DeltaCode is a tool to compare and report scan differences.
421421
When comparing files, it only uses exact comparison.
422422
The goal of this project is to improve the usefulness of the delta by also
423-
finding files that are mostly the same (e.g. quasi or nrea duplicates) vs. files
423+
finding files that are mostly the same (e.g. quasi or near duplicates) vs. files
424424
that are completely different. Then the DeltaCode comparison core should be
425425
updated accordingly to detect and report material changes to scans (such as
426-
new, update or removed licenses, origins and packages) when changes are also
427-
meterial in the code files (e.g. such that small changes may be ignored)
426+
new, updated or removed licenses, origins and packages) when changes are also
427+
material in the code files (e.g. such that small changes may be ignored)
428428

429429

430430
- **Level**
@@ -454,7 +454,7 @@ TraceCode projects
454454

455455
TraceCode does system call tracing only today. The primary goal of this project
456456
is to create a tool that provides the same results as the strace-based tracing
457-
but would be using using ELF symbols, DWARF debug symbols, signatures or string
457+
but would be using ELF symbols, DWARF debug symbols, signatures or string
458458
matching to determine when and how a source code file is built in a binary
459459
using only a static analysis. The primary target should be Linux executables,
460460
though the code should be designed to be extensible to Windows PE and macOS Dylib and exes.
@@ -593,13 +593,13 @@ The features and TODO for this updated server would be:
593593
- Aggregate more and new packages vulnerabilities feeds,
594594

595595
- Automating correlation: add smart relationship detection to infer new
596-
relatiosnhips between available packages and vulnerabilities from mining the
596+
relationships between available packages and vulnerabilities from mining the
597597
graph of existing relations.
598598

599599
- Create a ScanCode plugin to report vulnerabilities with detected packages
600600
using this data.
601601

602-
- Integrate API lookup on the server withe the AboutCode Manager UI
602+
- Integrate API lookup on the server with the AboutCode Manager UI
603603

604604
- Create a UI and model for community curation of vulnerability to package
605605
mappings, correlations and enhancements.
@@ -657,7 +657,7 @@ There are several areas to research and prototype such as:
657657
- A data structure to match efficiently a batch of fix-width checksums (e.g.
658658
SHA1) against a large index of such checksums, where each checksum points to
659659
one or more files or packages. A possible direction is to use finite state
660-
transducers, specialized B-tree indexes, blomm-like filters. Since when a
660+
transducers, specialized B-tree indexes, bloom-like filters. Since when a
661661
codebase is being matched there can be millions of lookups to do, the batch
662662
matching is preferred.
663663

@@ -677,7 +677,7 @@ There are several areas to research and prototype such as:
677677

678678
- Feature hashing research: we deal with many "features" and hashing to limit
679679
the number and size of the each features seems to be a valuable thing. The goal
680-
is to research the validaty of feature hashing with short hashes (15, 16 and
680+
is to research the validity of feature hashing with short hashes (15, 16 and
681681
32 bits) and evaluate if this leads to acceptable false-positive and loss of
682682
accuracy in the context of the data structures mentioned above.
683683

@@ -708,5 +708,5 @@ This is a green field project.
708708
Mentoring
709709
---------
710710

711-
We welcome new mentors to help with the program and require some good unerstanding of the project
711+
We welcome new mentors to help with the program and require some good understanding of the project
712712
codebase and domain to join as a mentor. Contact the team on Gitter.

docs/source/contributing.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Contributing to AboutCode
33
#########################
44

55
We welcome you and your interest in contributing to open source software! AboutCode
6-
is always looking for enthusiatic contributors and we are happy to help with any questions
6+
is always looking for enthusiastic contributors and we are happy to help with any questions
77
or comments. Here a few resources to get started:
88

99
1) Take a look through our public repos here: https://github.com/aboutcode-org/

docs/source/contributing/contrib_doc.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Ensure that you have the latest files::
8181
git pull
8282
git status
8383

84-
Before commiting changes run Continious Integration Scripts locally to run tests. Refer
84+
Before committing changes run Continuous Integration Scripts locally to run tests. Refer
8585
:ref:`doc_ci` for instructions on the same.
8686

8787
Follow standard git procedures to upload your new and modified files. The following commands are
@@ -189,7 +189,7 @@ Intersphinx
189189
ScanCode toolkit documentation uses `Intersphinx <http://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html>`_
190190
to link to other Sphinx Documentations, to maintain links to other Aboutcode Projects.
191191

192-
To link sections in the same documentation, standart reST labels are used. Refer
192+
To link sections in the same documentation, standard reST labels are used. Refer
193193
`Cross-Referencing <http://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#ref-role>`_ for more information.
194194

195195
For example::
@@ -203,7 +203,7 @@ For example::
203203

204204
It refers to the section itself, see :ref:`my-reference-label`.
205205

206-
Now, using Intersphinx, you can create these labels in one Sphinx Documentation and then referance
206+
Now, using Intersphinx, you can create these labels in one Sphinx Documentation and then reference
207207
these labels from another Sphinx Documentation, hosted in different locations.
208208

209209
You just have to add the following in the ``conf.py`` file for your Sphinx Documentation, where you
@@ -242,7 +242,7 @@ For more information, refer this tutorial named
242242

243243
.. _doc_style_conv:
244244

245-
Style Conventions for the Documentaion
245+
Style Conventions for the Documentation
246246
--------------------------------------
247247

248248
1. Headings

docs/source/contributing/writing_good_commit_messages.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The main style points are these:
1616

1717
Subject:
1818

19-
- Add a issue number at the end of the line when available as in "#234"
19+
- Add an issue number at the end of the line when available as in "#234"
2020
- Limit the subject line to 50 characters
2121
- Capitalize the subject line
2222
- Do not end the subject line with a period
@@ -35,7 +35,7 @@ Body:
3535
Other comments:
3636

3737
We like to suffix the subject line with an issue number. If this was a trivial change it may not
38-
have one though. If it had one a you would use ``#156`` as a suffix to the first line.
38+
have one though. If it had one you would use ``#156`` as a suffix to the first line.
3939

4040
We like to tell why the commit is there and use an imperative style, like if you were giving an
4141
order to the codebase with your commit:

0 commit comments

Comments
 (0)