Skip to content

Latest commit

 

History

History
121 lines (76 loc) · 2.64 KB

Contributing.md

File metadata and controls

121 lines (76 loc) · 2.64 KB

Developers' Guide

This document describes how to contribute to hyperbench project. It is an entry point for developers who are interested in build, develop, create an issue or pull request to hyperbench.

Building and Testing

1. clone

git clone git@github.com:meshplus/hyperbench.git

2. build

make build

3. run test

make test

Workflow

1. fork

visit https://github.com/meshplus/hyperbench, click fork button

2. clone

We assume that you have go v1.13 installed, and GOPATH is set.

Create your clone:

git clone git@github.com:$user/hyperbench.git $GOPATH/src/github.com/meshplus/hyperbench

3. fetch && rebase

Get your local master up to date:

cd $GOPATH/src/github.com/meshplus/hyperbench
git fetch upstream
git checkout master
git rebase upstream/master
npm install

4. branch

Branch from it:

git checkout -b myfeature

Then edit code on the myfeature branch.

5. commit

If already run npm install ,use git cz instead ofgit commit. If not, use git commit.

git cz

6. push

When ready to review (or just to establish an offsite backup or your work), push your branch to your fork on github.com:

git push -f ${your_remote_name} myfeature

7. create pull request

  1. Visit your fork at https://github.com/$user/hyperbench
  2. Click the Compare & Pull Request button next to your myfeature branch.

Contributing

Each contributor should follow the git workflow. If your use of git is not particularly clear, please read this document first.

If you would like to contribute to hyperbench, please fork, commit and send a pull request for maintainers to review code and merge to main code base.

Issue

If use want to create a issue, please follow this issue template.

#### Environment

hyperbench version: `hyperbench --version`
OS: Windows/Linux/OSX
Commit hash:

#### What happened:

#### What you expected to happen:

#### How to reproduce it (as minimally and precisely as possible):

#### Backtrace

​````
[backtrace]
​````

Pull request

  • Pull request should be based on hyperbench's master branch
  • Commit messages should begin with the package name they modify, e.g.
    • core/executor: use default parameters to initialize executor
  • Please use golangci-lint tool to format the source code before submit changes

We encourage any form of contribution, no matter it's bug fixes, new features, or something else. Our team will do our best to make every valuable contribution to get merged as soon as possile.