Skip to content

Update README.md and add CONTRIBUTING.md #171

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.

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
merged 32 commits into from
May 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
a87035b
Fix some small issues that were flagged by upcoming lint checks.
rsned Apr 2, 2025
ed507ae
replace the swap edges, newEdges which left a dangling value with _
rsned Apr 2, 2025
39caea7
Add todo on this //nolint.
rsned Apr 2, 2025
69704c9
Add linter/formatter/govet github action.
rsned Apr 2, 2025
12554af
Merge branch 'golang:master' into master
rsned Apr 3, 2025
55902bd
Fix OSSF detected go.mod toolchain version issue.
rsned Apr 3, 2025
4f7483f
update to use git hashes instead of @v5 style.
rsned Apr 4, 2025
e141dbf
Use dependabot compatible version comments
alan-strohm Apr 4, 2025
c597829
Add comments on disabled checks. Add a few more entries.
rsned Apr 8, 2025
5836f6f
Merge branch 'golang:master' into master
rsned Apr 8, 2025
7c7e52c
Merge remote-tracking branch 'refs/remotes/origin/master'
rsned Apr 8, 2025
6df2625
Update some comments and add in reference to related issue number for…
rsned Apr 8, 2025
0f45e9d
Remove govet from enabled. Drop exclusions. Clarify some comments.
rsned Apr 8, 2025
6937d18
Fix some typos
alan-strohm Apr 9, 2025
aeac25e
Set gofmt formatter to keep the default -s (simplify option)
rsned Apr 10, 2025
6570bb0
Re-disable simplify until existing files are fixed.
rsned Apr 10, 2025
46b2465
Update permissions to read-all
rsned Apr 10, 2025
c8d0c06
Remove simply: false from format checks.
rsned Apr 10, 2025
a09abef
Merge branch 'golang:master' into master
rsned Apr 10, 2025
cc51d8b
read-all should be on permissions, not the specific sub element.
rsned Apr 10, 2025
61272a9
Merge remote-tracking branch 'refs/remotes/origin/master'
rsned Apr 10, 2025
f996d29
Merge branch 'golang:master' into master
rsned Apr 12, 2025
63e5133
drop comment on pull requests.
rsned Apr 14, 2025
9a1faa3
Merge remote-tracking branch 'refs/remotes/origin/master'
rsned Apr 14, 2025
05836a2
Merge branch 'golang:master' into master
rsned Apr 14, 2025
86e764d
Merge branch 'golang:master' into master
rsned Apr 17, 2025
b8bbe24
Merge branch 'golang:master' into master
rsned Apr 23, 2025
1773558
Merge branch 'golang:master' into master
rsned May 2, 2025
1d54309
Update README with more of the parts not yet added from C++.
rsned May 3, 2025
821cb4f
Merge branch 'golang:master' into master
rsned May 3, 2025
a7e3ac9
Add CONTRIBUTING.md based on the C++ file.
rsned May 3, 2025
1a16be9
Merge branch 'master' of ssh://github.com/rsned/geo
rsned May 3, 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
62 changes: 62 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# How to contribute #

We'd love to accept your patches and contributions to this project. There are
a just a few small guidelines you need to follow.


## Contributor License Agreement ##

Contributions to any Google project must be accompanied by a Contributor
License Agreement. This is not a copyright **assignment**, it simply gives
Google permission to use and redistribute your contributions as part of the
project.

* If you are an individual writing original source code and you're sure you
own the intellectual property, then you'll need to sign an [individual
CLA][].

* If you work for a company that wants to allow you to contribute your work,
then you'll need to sign a [corporate CLA][].

You generally only need to submit a CLA once, so if you've already submitted
one (even if it was for a different project), you probably don't need to do it
again.

[individual CLA]: https://developers.google.com/open-source/cla/individual
[corporate CLA]: https://developers.google.com/open-source/cla/corporate


## Submitting a patch ##

1. It's generally best to start by opening a new issue describing the bug or
feature you're intending to fix. Even if you think it's relatively minor,
it's helpful to know what people are working on. Mention in the initial
issue that you are planning to work on that bug or feature so that it can
be assigned to you.

1. Follow the normal process of [forking][] the project, and setup a new
branch to work in. It's important that each group of changes be done in
separate branches in order to ensure that a pull request only includes the
commits related to that bug or feature.

1. Do your best to have [well-formed commit messages][] with a [good
description][] for each change. This provides consistency throughout
the project, and ensures that commit messages are able to be formatted
properly by various git tools.

1. Keep PRs [small and focused][] on a single issue. Do not make unrelated
changes in the same PR "because you're there"; this includes reformatting
of code, whether automatically or manually.

1. Finally, push the commits to your fork and submit a [pull request][].

[forking]: https://help.github.com/articles/fork-a-repo
[well-formed commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[good description]: https://google.github.io/eng-practices/review/developer/cl-descriptions.html
[pull request]: https://help.github.com/articles/creating-a-pull-request
[small and focused]: https://google.github.io/eng-practices/review/developer/small-cls.html


## Style ##

Contributions should follow the [Go Style Guide](https://google.github.io/styleguide/go). Code should be [formatted] with `gofmt`.
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ S2ConvexHull | ✅
S2CrossingEdge | ✅
S2HausdorffDistance | ❌
S2ShapeNesting | ❌
S2ValidationQuery | ❌

### Supporting Types

Expand All @@ -203,32 +204,37 @@ C++ Type | Go
S2BooleanOperation | ❌
S2BufferOperation | ❌
S2Builder | ❌
S2BuilderClosedSetNormalizer | ❌
S2BuilderFindPolygonDegeneracies | ❌
S2BuilderGraph | ❌
S2BuilderLayers | ❌
S2BuilderSnapFunctions | ❌
S2BuilderTesting | ❌
S2Builderutil\* | ❌
S2BuilderLayer | ❌
S2BuilderUtil_\* | ❌
S2CellIterator | ❌
S2CellIteratorJoin | ❌
S2CellRangeIterator | ❌
S2Coder | ❌
S2Earth | ❌
S2EdgeClipping | ✅
S2EdgeCrosser | ✅
S2EdgeCrossings | ✅
S2EdgeDistances | ✅
S2EdgeTessellator | ✅
S2Fractal | ❌
S2LoopMeasures | ❌
S2Measures | ✅
S2MemoryTracker | ❌
S2Metrics | ❌
S2PointUtil | 🟡
S2PointCompression | 🟡
S2PolygonBuilder | ❌
S2PolylineAlignment | ❌
S2PolylineMeasures | ✅
S2PolylineSimplifier | ❌
S2Predicates | ✅
S2Projections | ❌
S2rectBounder | ❌
S2Random | ❌
S2RectBounder | ❌
S2RegionSharder | ❌
S2RegionTermIndexer | ❌
S2ShapeIndexBufferedRegion | ❌
S2ShapeIndexMeasures | ❌
S2ShapeIndexUtil\* | 🟡
S2ShapeMeasures | ❌
Expand All @@ -239,7 +245,13 @@ S2TextFormat | ✅
S2WedgeRelations | ✅
S2WindingOperation | ❌


### Encode/Decode

Encoding and decoding of S2 types is fully implemented and interoperable with
C++ and Java.


## Disclaimer

This is not an official Google product.