Skip to content

Commit 5cc4d5c

Browse files
committed
chore: housekeeping on docs
1 parent d6054b3 commit 5cc4d5c

File tree

3 files changed

+10
-7
lines changed

3 files changed

+10
-7
lines changed

CHANGELOG.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
# Changelog
22

3-
All notable changes to this project will be documented in this file. The
4-
format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
5-
63
This project tracks the **major** and **minor** versions set upstream by
74
[`h3`](github.com/uber/h3), and introduces backwards-compatible updates and/or
85
fixes via **patches** with patch version bumps.
96

7+
**Changelog notes for versions above v4 are under [Releases](https://github.com/uber/h3-go/releases).**
8+
109
## 4.0.0
1110

1211
All new functions to match H3 v4.
@@ -84,4 +83,4 @@ See <https://h3geo.org/docs/library/migrating-3.x> for upstream changes, and the
8483

8584
### Added
8685

87-
* everything! first commit.
86+
* everything! first commit.

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ Generate coverage:
3232
go test -coverprofile=c.out && go tool cover -html=c.out
3333
```
3434

35+
### Using VSCode
36+
37+
`golangci-lint` version 2 requires the pre-release version of the `golang.go` extension:
38+
39+
https://golangci-lint.run/welcome/integrations/#visual-studio-code
40+
3541
## Other ways to contribute
3642

3743
You may also be interested in [contributing to the @uber/h3

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@
55
[![Go Report Card](https://goreportcard.com/badge/github.com/uber/h3-go/v4)](https://goreportcard.com/report/github.com/uber/h3-go)
66
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
77
[![GoDoc](http://img.shields.io/badge/go-doc-blue.svg)](https://godoc.org/github.com/uber/h3-go)
8-
[![H3 Version](https://img.shields.io/badge/h3-v4.1.0-blue.svg)](https://github.com/uber/h3/releases/tag/v4.1.0)
9-
10-
<h1 align="center">H3-Go is looking for a maintainer familiar with Go, C, and H3. Volunteers welcome! Please get in touch with us on the <a href="https://join.slack.com/t/h3-core/shared_invite/zt-g6u5r1hf-W_~uVJmfeiWtMQuBGc1NNg">H3 Slack</a>.</h1>
8+
[![H3 Version](https://img.shields.io/badge/h3-v4.2.1-blue.svg)](https://github.com/uber/h3/releases/tag/v4.2.1)
119

1210
# H3-Go
1311

0 commit comments

Comments
 (0)