CONTRIBUTING.md (1534B)
1 # Contributing to Ebiten 2 3 Ebiten is an open source project and we would appricate your conributions! 4 5 There are some rules for Ebiten contribution. 6 7 ## Asking us when you are not sure 8 9 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. 10 11 ## Following the Go convention 12 13 Please follow the Go convension like [Effective Go](https://golang.org/doc/effective_go.html). 14 For example, formatting by `go fmt` is required. 15 16 ## Adding copyright comments to each file 17 18 ```go 19 // Copyright [YYYY] The Ebiten Authors 20 // 21 // Licensed under the Apache License, Version 2.0 (the "License"); 22 // you may not use this file except in compliance with the License. 23 // You may obtain a copy of the License at 24 // 25 // http://www.apache.org/licenses/LICENSE-2.0 26 // 27 // Unless required by applicable law or agreed to in writing, software 28 // distributed under the License is distributed on an "AS IS" BASIS, 29 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 30 // See the License for the specific language governing permissions and 31 // limitations under the License. 32 ``` 33 34 You don't have to update existing files' license comments. 35 36 ## Adding build tags for examples 37 38 ```go 39 // +build example 40 ``` 41 42 `example` is to prevent from installing executions by `go get github.com/hajimehoshi/ebiten/v2/...`. 43 44 ## Documentation 45 46 See the [documents](https://ebiten.org/documents/implementation.html) about internal implementation.