Closed h5law closed 10 months ago
All modified and coverable lines are covered by tests :white_check_mark:
Comparison is base (
db06038
) 83.28% compared to head (179f616
) 83.28%.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
Summary
Human Summary
This PR moves all documentation to the
docs/
subdir and updates the workflow files. It also makes codecov informational only instead of passing/failing CI checks.AI Summary
Summary generated by Reviewpad on 03 Jan 24 14:06 UTC
This pull request includes the following changes:
Ignoring specific files and directories: The ".DS_Store" file, which are Mac OS X system files, and the ".idea/" directory, which contains Goland and JetBrains IDE files, are now being ignored. Additionally, a new file called ".tool-versions" is also being ignored, which is a local tool-versions file for asdf.
Changes to the
.github/codecov.yml
file: This file has been added with a mode of 100644. Thecoverage
section has been added with thestatus
configuration. Theinformational
property has been set totrue
for both theproject
andpatch
sections.Renaming and content changes for the
SMT.md
file: The file has been renamed tosmt.md
and includes an added section on "Closest Proof Use Cases." The "Compression" and "Data Loss" sections have been updated. An additional change is the renaming of documentation links for "KVStore" and "MerkleSumTrie" to lowercase.Changes to the
docs/KVStore.md
file: This file has undergone a 90% similarity index change and has been renamed tokvstore.md
. The changes involve reformatting the indentation of subheadings under the "Implementation" and "Accessor Methods" sections.Changes to the
MerkleSumTrie.md
file: The filename has been changed tomerkle-sum-trie.md
. There have been changes in the headings and subheadings, including indentation adjustments. A file link for theSMT documentation
has also been updated.Updates to the
test.yml
file: The workflow name has been changed, the value of an environment variable has been updated, and various modifications have been made to different steps.Please review these changes and ensure that they align with the intended modifications.
Issue
N/A
Type of change
Please mark the relevant option(s):
Testing
make test_all
make benchmark_{all | suite name}
Required Checklist
godoc
format comments see: tip.golang.org/doc/comment)If Applicable Checklist