Contributing to Ebiten

Ebiten is an open source project and we appreciate your contributions!

There are some rules for Ebiten contribution.

Filing an issue in the GitHub issue

File an issue in the GitHub issues, if you find a problem or have a feature request but this is not filed.

Except for very trivial fixes like fixing misspelling, it is a must to have an issue.

Asking us when you are not sure

In Ebiten, problems might not be documented very well in GitHub issues. Please ask us before you work on such issue.

You can ask us at these communities:

Following the Go convention

Please follow the Go convension like Effective Go. For example, formatting by go fmt is required.

Adding copyright comments to each file

// Copyright [YYYY] The Ebiten Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

You don't have to update existing files' license comments.

Adding build tags for examples

//go:build example
// +build example

example is to prevent from installing executions by go get github.com/hajimehoshi/ebiten/v2/....

Implementation details

See the documents about internal implementation.

Fixing the documentation

Ebiten's documentations are managed at ebiten/ebiten.org.

Before submitting a documentation PR, read through the README in that repo.

2.2 KiB Raw Blame History