Skip to content

Fix linter errors in markdown #122

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.

Sign up for GitHub

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

Merged
TomTonic merged 3 commits into from
Aug 11, 2025
Merged

Fix linter errors in markdown #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
33618f5
Update Go version from 1.24.3 to 1.24.6
TomTonic Aug 10, 2025
524870d
docs: Update CONTRIBUTING.md and README.md for linter conformity
TomTonic Aug 11, 2025
14fe759
Merge branch 'main' into Fix-linter-errors-in-Markdown
TomTonic Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,12 @@ free of known issues.
We categorize proposals into two types:

1. **Low-risk modifications.** Proposed by authorized committers, pass all

tests, and are unlikely to have problems. These include documentation
updates and minor function updates. The project lead can designate any
modification as low-risk.

2. Other modifications. Require review by someone else or acceptance by the

project lead. Typically, this involves creating a branch and a pull request
for review before acceptance.

Expand All @@ -77,7 +78,9 @@ by a blank line from the body of the commit:

````txt
Signed-off-by: YOUR NAME <[email protected]>
````
```

`

You can sign-off by default in this project by creating a file
(say "git-template") that contains
Expand All @@ -86,7 +89,9 @@ then configure git to use that as a commit template. For example:

````sh
git config commit.template ~/best-practices-badge/git-template
````
```

`

It's not practical to fix old contributions in git, so if one is forgotten,
do not try to fix them. We presume that if someone sometimes used a DCO,
Expand Down Expand Up @@ -163,6 +168,7 @@ Follow these guidelines for writing git commit messages:
5. Use the imperative mood in the subject line (*command* form).
6. Wrap the body at 72 characters (`fmt -w 72`).
7. Use the body to explain what and why, not how

(git tracks how it was changed in detail, don't repeat that).

## Reuse (Supply Chain)
Expand Down
3 changes: 1 addition & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ The following benchmarks have been performed with [v0.4.0](https://github.com/To
go test -v -count=1 -run "^(TestSet3Fill|TestNativeMapFill|TestSet3Find|TestNativeMapFind)$" github.com/TomTonic/Set3 -timeout=120m > benchresult.txt
```

(Raw benchmark results are available [here](https://raw.githubusercontent.com/TomTonic/Set3/main/benchresult.txt). Go version 1.23.1, no PGO.
(Raw benchmark results are available [in plain text](https://raw.githubusercontent.com/TomTonic/Set3/main/benchresult.txt). Go version 1.23.1, no PGO.
Please note that you have to comment out the instructions to skip the tests first (`t.Skip("...")`). The whole benchmark runs about 45 minutes.)

### Inserting Nodes into an Empty Set
Expand Down Expand Up @@ -108,4 +108,3 @@ The x-axis represents sets of varying sizes, and the y-axis indicates the averag

n = 1 ... 300 (step size +1, linear scale)
![Time for Searching Random Values in a Set of Size n, 30% Hit Rate, n = 1 ... 300 (step size +1, linear scale)](https://github.com/user-attachments/assets/bf77efc4-fb60-4de4-a65e-087318e3958c)

2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module github.com/TomTonic/Set3

go 1.24.3
go 1.24.6

require (
github.com/dolthub/maphash v0.1.0
Expand Down
Loading