Contributing to Arana
- The name of branches
SHOULDbe in the format offeature/xxx.- You
SHOULDcheckout a new branch after a feature branch already being merged into upstream,DO NOTcommit in the old branch.
The pr head format is <head> <subject>. The title should be simpler to show your intent.
The title format of the pull request MUST follow the following rules:
- Start with
Doc:for adding/formatting/improving docs.- Start with
Mod:for formatting codes or adding comment.- Start with
Fix:for fixing bug, and its ending should be#issue-idif being relevant to some issue.- Start with
Imp:for improving performance.- Start with
Ftr:for adding a new feature.- Start with
Add:for adding struct function/member.- Start with
Rft:for refactoring codes.- Start with
Tst:for adding tests.- Start with
Dep:for adding depending libs.- Start with
Rem:for removing feature/struct/function/member/files.
Please add a blank line at the end of every file.
Please add a blank line at the sub-title and its content.
Please add s space between the Engilsh word/digit number and the Chinese character.
We import blocks should be splited into 3 blocks.
// block 1: the go internal package
import (
"fmt"
)
// block 2: the third package
import (
"github.com/pkg/errors"
"gopkg.in/yaml.v3"
)
// block 3: the arana package
import (
"github.com/arana-db/arana/pkg/config"
"github.com/arana-db/arana/pkg/proto/rule"
)There are some aided development tools.
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latestgo install github.com/apache/skywalking-eyes/cmd/license-eye@latestgo install github.com/dubbogo/tools/cmd/imports-formatter@latestA framework for managing and maintaining multi-language pre-commit hooks. Pre-commit is highly recommended.
Using pip:
pip install pre-commitUsing homebrew:
brew install pre-commit