Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@wagoodman
Copy link
Contributor

Adds developer documentation around getting started in the repo and testing levels. I've also added an outline for the architecture section as a starter for future PRs.

Signed-off-by: Alex Goodman <[email protected]>
Signed-off-by: Alex Goodman <[email protected]>
@wagoodman wagoodman requested a review from a team January 13, 2022 19:51
@wagoodman wagoodman self-assigned this Jan 13, 2022
@github-actions
Copy link

github-actions bot commented Jan 13, 2022

Benchmark Test Results

Benchmark results from the latest changes vs base branch
name                                                       old time/op    new time/op    delta
ImagePackageCatalogers/ruby-gemspec-cataloger-2              1.28ms ± 5%    1.35ms ± 1%   +5.59%  (p=0.008 n=5+5)
ImagePackageCatalogers/python-package-cataloger-2            2.91ms ± 1%    3.22ms ± 5%  +10.80%  (p=0.008 n=5+5)
ImagePackageCatalogers/php-composer-installed-cataloger-2     874µs ± 1%     990µs ± 4%  +13.35%  (p=0.008 n=5+5)
ImagePackageCatalogers/javascript-package-cataloger-2         762µs ± 1%     830µs ± 0%   +8.88%  (p=0.008 n=5+5)
ImagePackageCatalogers/dpkgdb-cataloger-2                     887µs ± 1%     959µs ± 0%   +8.06%  (p=0.008 n=5+5)
ImagePackageCatalogers/rpmdb-cataloger-2                      807µs ± 1%     860µs ± 0%   +6.53%  (p=0.008 n=5+5)
ImagePackageCatalogers/java-cataloger-2                      12.1ms ± 1%    12.9ms ± 0%   +6.39%  (p=0.008 n=5+5)
ImagePackageCatalogers/apkdb-cataloger-2                     1.20ms ± 1%    1.28ms ± 1%   +6.05%  (p=0.008 n=5+5)
ImagePackageCatalogers/go-module-binary-cataloger-2          1.70µs ± 1%    1.95µs ± 1%  +14.60%  (p=0.008 n=5+5)

name                                                       old alloc/op   new alloc/op   delta
ImagePackageCatalogers/ruby-gemspec-cataloger-2               253kB ± 0%     253kB ± 0%     ~     (p=0.421 n=5+5)
ImagePackageCatalogers/python-package-cataloger-2            1.06MB ± 0%    1.06MB ± 0%   -0.14%  (p=0.008 n=5+5)
ImagePackageCatalogers/php-composer-installed-cataloger-2     230kB ± 0%     230kB ± 0%     ~     (p=0.421 n=5+5)
ImagePackageCatalogers/javascript-package-cataloger-2         208kB ± 0%     207kB ± 0%   -0.21%  (p=0.008 n=5+5)
ImagePackageCatalogers/dpkgdb-cataloger-2                     254kB ± 0%     253kB ± 0%   -0.27%  (p=0.016 n=5+4)
ImagePackageCatalogers/rpmdb-cataloger-2                      235kB ± 0%     235kB ± 0%   -0.11%  (p=0.032 n=5+5)
ImagePackageCatalogers/java-cataloger-2                      3.63MB ± 0%    3.62MB ± 0%   -0.22%  (p=0.032 n=5+5)
ImagePackageCatalogers/apkdb-cataloger-2                     1.30MB ± 0%    1.30MB ± 0%   -0.08%  (p=0.016 n=5+5)
ImagePackageCatalogers/go-module-binary-cataloger-2            560B ± 0%      560B ± 0%     ~     (all equal)

name                                                       old allocs/op  new allocs/op  delta
ImagePackageCatalogers/ruby-gemspec-cataloger-2               6.33k ± 0%     6.33k ± 0%     ~     (all equal)
ImagePackageCatalogers/python-package-cataloger-2             21.4k ± 0%     21.4k ± 0%     ~     (p=0.683 n=5+5)
ImagePackageCatalogers/php-composer-installed-cataloger-2     6.06k ± 0%     6.06k ± 0%     ~     (p=1.000 n=5+5)
ImagePackageCatalogers/javascript-package-cataloger-2         5.34k ± 0%     5.34k ± 0%     ~     (all equal)
ImagePackageCatalogers/dpkgdb-cataloger-2                     7.07k ± 0%     7.07k ± 0%     ~     (all equal)
ImagePackageCatalogers/rpmdb-cataloger-2                      6.80k ± 0%     6.80k ± 0%     ~     (all equal)
ImagePackageCatalogers/java-cataloger-2                       69.7k ± 0%     69.7k ± 0%     ~     (p=0.833 n=5+5)
ImagePackageCatalogers/apkdb-cataloger-2                      7.36k ± 0%     7.36k ± 0%     ~     (p=0.333 n=4+5)
ImagePackageCatalogers/go-module-binary-cataloger-2            13.0 ± 0%      13.0 ± 0%     ~     (all equal)

Signed-off-by: Alex Goodman <[email protected]>
Copy link
Contributor

@spiffcs spiffcs left a comment

Choose a reason for hiding this comment

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

Wow great addition @wagoodman

Signed-off-by: Alex Goodman <[email protected]>
@wagoodman wagoodman merged commit 86c3c1c into main Jan 14, 2022
@wagoodman wagoodman deleted the add-developer-documentation branch January 14, 2022 11:17
spiffcs added a commit that referenced this pull request Jan 19, 2022
…hub.com/hectorj2f/syft into hectorj2f/add_dependencies_to_cyclonedx

* 'hectorj2f/add_dependencies_to_cyclonedx' of https://github.com/hectorj2f/syft: (29 commits)
  Improve CycloneDX format output (#710)
  Add additional PHP metadata (#753)
  Update Syft formats for SyftJson (#752)
  Add support for "file" source type in syftjson unmarshaling (#750)
  remove contains file from spdx dependency generation
  support .sar for java ecosystem (#748)
  Start developer documentation (#746)
  Align SPDX export more with SPDX 2.2 specification (#743)
  Replace distro type (#742)
  update goreleaser with windows checksums (#740)
  bump stereoscope version to remove old containerd (#741)
  Add support for multiple output files in different formats (#732)
  Add support for searching for jars within archives (#734)
  683 windows filepath (#735)
  Fix CPE encode/decode when it contains special chars (#714)
  support .par for java ecosystems (#727)
  Add arm64 support to install script (#729)
  Revert "bump goreleaser to v1.2 (#720)" (#731)
  Add a version flag (#722)
  Add lpkg as java package format (#694)
  ...
fengshunli pushed a commit to fengshunli/syft that referenced this pull request Jan 24, 2022
* draft outline for developing docs

Signed-off-by: Alex Goodman <[email protected]>

* update outline

Signed-off-by: Alex Goodman <[email protected]>

* list testing dependencies

Signed-off-by: Alex Goodman <[email protected]>

* fix header indention

Signed-off-by: Alex Goodman <[email protected]>

* fix title

Signed-off-by: Alex Goodman <[email protected]>
Signed-off-by: fsl <[email protected]>
spiffcs pushed a commit that referenced this pull request Jan 24, 2022
* draft outline for developing docs

Signed-off-by: Alex Goodman <[email protected]>

* update outline

Signed-off-by: Alex Goodman <[email protected]>

* list testing dependencies

Signed-off-by: Alex Goodman <[email protected]>

* fix header indention

Signed-off-by: Alex Goodman <[email protected]>

* fix title

Signed-off-by: Alex Goodman <[email protected]>
Signed-off-by: Christopher Phillips <[email protected]>
spiffcs pushed a commit that referenced this pull request Jan 25, 2022
* draft outline for developing docs

Signed-off-by: Alex Goodman <[email protected]>

* update outline

Signed-off-by: Alex Goodman <[email protected]>

* list testing dependencies

Signed-off-by: Alex Goodman <[email protected]>

* fix header indention

Signed-off-by: Alex Goodman <[email protected]>

* fix title

Signed-off-by: Alex Goodman <[email protected]>
jonasagx pushed a commit to jonasagx/syft that referenced this pull request Jan 28, 2022
* draft outline for developing docs

Signed-off-by: Alex Goodman <[email protected]>

* update outline

Signed-off-by: Alex Goodman <[email protected]>

* list testing dependencies

Signed-off-by: Alex Goodman <[email protected]>

* fix header indention

Signed-off-by: Alex Goodman <[email protected]>

* fix title

Signed-off-by: Alex Goodman <[email protected]>
GijsCalis pushed a commit to GijsCalis/syft that referenced this pull request Feb 19, 2024
* draft outline for developing docs

Signed-off-by: Alex Goodman <[email protected]>

* update outline

Signed-off-by: Alex Goodman <[email protected]>

* list testing dependencies

Signed-off-by: Alex Goodman <[email protected]>

* fix header indention

Signed-off-by: Alex Goodman <[email protected]>

* fix title

Signed-off-by: Alex Goodman <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants