From c87f09fe351825aa0cad0b2bcf7b635ae7f73257 Mon Sep 17 00:00:00 2001 From: Hajime Hoshi Date: Sun, 3 Nov 2019 15:23:33 +0900 Subject: [PATCH] docs: Update CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5292f30a8..e82d596f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,16 +4,16 @@ Ebiten is an open source project and we would appricate your conributions! There are some rules for Ebiten contribution. -## Ask us when you are not sure +## Asking us when you are not sure You can ask us by [creating a GitHub issue](https://github.com/hajimehoshi/ebiten/issues/new) or at [Gophers Slack](https://invite.slack.golangbridge.org/)'s #ebiten channel. -## Follow the Go convention +## Following the Go convention Please follow the Go convension like [Effective Go](https://golang.org/doc/effective_go.html). For example, formatting by `go fmt` is required. -## Add copyright comments to each file +## Adding copyright comments to each file ```go // Copyright [YYYY] The Ebiten Authors @@ -33,7 +33,7 @@ For example, formatting by `go fmt` is required. You don't have to update existing files' license comments. -## Add build tags for examples +## Adding build tags for examples ```go // +build example jsgo @@ -42,3 +42,7 @@ You don't have to update existing files' license comments. `example` is to prevent from installing executions by `go get github.com/hajimehoshi/ebiten/...`. `jsgo` is to make the examples work on [jsgo.io](https://jsgo.io/). + +## Documentation + +See the [documents](https://ebiten.org/implementation.html) about internal implementation.