mth/ebiten
1
0
Fork 0
mirror of https://github.com/hajimehoshi/ebiten.git synced 2024-11-10 04:57:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Hajime Hoshi 2019-11-03 15:23:33 +09:00
parent d2ff834cdb
commit c87f09fe35
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -4,16 +4,16 @@ Ebiten is an open source project and we would appricate your conributions!
There are some rules for Ebiten contribution. 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. 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). Please follow the Go convension like [Effective Go](https://golang.org/doc/effective_go.html).
For example, formatting by `go fmt` is required. For example, formatting by `go fmt` is required.
## Add copyright comments to each file ## Adding copyright comments to each file
```go ```go
// Copyright [YYYY] The Ebiten Authors // 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. You don't have to update existing files' license comments.
## Add build tags for examples ## Adding build tags for examples
```go ```go
// +build example jsgo // +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/...`. `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/). `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.