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