{"id":13600711,"url":"https://github.com/beego/bee","last_synced_at":"2025-05-13T20:07:42.980Z","repository":{"id":38014935,"uuid":"14003071","full_name":"beego/bee","owner":"beego","description":"Bee is a tool for helping develop with beego app framework.","archived":false,"fork":false,"pushed_at":"2024-12-21T08:08:13.000Z","size":3564,"stargazers_count":1458,"open_issues_count":157,"forks_count":923,"subscribers_count":82,"default_branch":"develop","last_synced_at":"2025-04-02T01:06:34.729Z","etag":null,"topics":["automation","beego","beego-application","go","swagger"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/beego.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-10-30T23:53:16.000Z","updated_at":"2025-03-26T10:24:19.000Z","dependencies_parsed_at":"2024-04-09T10:43:42.042Z","dependency_job_id":"1a8e2b7a-16f7-4ab6-bd41-b3a0231ddaae","html_url":"https://github.com/beego/bee","commit_stats":{"total_commits":765,"total_committers":157,"mean_commits":4.872611464968153,"dds":0.7895424836601307,"last_synced_commit":"670ee6d5e72bb2b712962046c31173272d802819"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beego%2Fbee","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beego%2Fbee/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beego%2Fbee/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beego%2Fbee/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/beego","download_url":"https://codeload.github.com/beego/bee/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247962414,"owners_count":21024860,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","beego","beego-application","go","swagger"],"created_at":"2024-08-01T18:00:47.094Z","updated_at":"2025-04-09T02:08:22.785Z","avatar_url":"https://github.com/beego.png","language":"Go","funding_links":[],"categories":["Go","Repositories"],"sub_categories":[],"readme":"\nbee\n===\n\nBee is a command-line tool facilitating development of Beego-based application.\n\n[![Build Status](https://img.shields.io/travis/beego/bee.svg?branch=master\u0026label=master)](https://travis-ci.org/beego/bee)\n[![Build Status](https://img.shields.io/travis/beego/bee.svg?branch=develop\u0026label=develop)](https://travis-ci.org/beego/bee)\n\n## Requirements\n\n- Go version \u003e= 1.13\n\n## Installation\n\nTo install or update `bee` use the `go install` command:\n\n```bash\ngo install github.com/beego/bee/v2@latest\n```\n\n## Then you can add `bee` binary to PATH environment variable in your `~/.bashrc` or `~/.bash_profile` file:\n\n```bash\nexport PATH=$PATH:\u003cyour_main_gopath\u003e/bin\n```\n\n## Installing and updating bee prior Go version 1.17\n\nTo install `bee` use the `go get` command:\n\n```bash\ngo get github.com/beego/bee/v2\n```\n\n\u003e If you already have `bee` installed, updating `bee` is simple:\n\n```bash\ngo get -u github.com/beego/bee/v2\n```\n\n## Basic commands\n\nBee provides a variety of commands which can be helpful at various stages of development. The top level commands include:\n\n```\n    version     Prints the current Bee version\n    migrate     Runs database migrations\n    api         Creates a Beego API application\n    bale        Transforms non-Go files to Go source files\n    fix         Fixes your application by making it compatible with newer versions of Beego\n    pro         Source code generator\n    dlv         Start a debugging session using Delve\n    dockerize   Generates a Dockerfile and docker-compose.yaml for your Beego application\n    generate    Source code generator\n    hprose      Creates an RPC application based on Hprose and Beego frameworks\n    new         Creates a Beego application\n    pack        Compresses a Beego application into a single file\n    rs          Run customized scripts\n    run         Run the application by starting a local development server\n    server      serving static content over HTTP on port\n    update      Update Bee\n```\n\n### bee version\n\nTo display the current version of `bee`, `beego` and `go` installed on your machine:\n\n```bash\n$ bee version\n______\n| ___ \\\n| |_/ /  ___   ___\n| ___ \\ / _ \\ / _ \\\n| |_/ /|  __/|  __/\n\\____/  \\___| \\___| v2.0.4\n\n├── Beego     : 2.0.4\n├── GoVersion : go1.14.1\n├── GOOS      : darwin\n├── GOARCH    : amd64\n├── NumCPU    : 4\n├── GOPATH    : /home/beeuser/.go\n├── GOROOT    : /usr/local/Cellar/go/1.14.1/libexec\n├── Compiler  : gc\n└── Published : 2020-09-13\n```\n\nYou can also change the output format using `-o` flag:\n\n```bash\n$ bee version -o json\n{\n    \"GoVersion\": \"go1.14.1\",\n    \"GOOS\": \"darwin\",\n    \"GOARCH\": \"amd64\",\n    \"NumCPU\": 4,\n    \"GOPATH\": \"/home/beeuser/.go\",\n    \"GOROOT\": \"/usr/local/Cellar/go/1.14.1/libexec\",\n    \"Compiler\": \"gc\",\n    \"BeeVersion\": \"2.0.4\",\n    \"BeegoVersion\": \"2.0.4\",\n    \"Published\": \"2020-09-13\"\n}\n```\n\nFor more information on the usage, run `bee help version`.\n\n### bee new\n\nTo create a new Beego web application:\n\n```bash\n$ bee new my-web-app\n2020/09/14 22:28:51 INFO     ▶ 0001 generate new project support go modules.\n2020/09/14 22:28:51 INFO     ▶ 0002 Creating application...\n\tcreate\t /Users/beeuser/learn/my-web-app/go.mod\n\tcreate\t /Users/beeuser/learn/my-web-app/\n\tcreate\t /Users/beeuser/learn/my-web-app/conf/\n\tcreate\t /Users/beeuser/learn/my-web-app/controllers/\n\tcreate\t /Users/beeuser/learn/my-web-app/models/\n\tcreate\t /Users/beeuser/learn/my-web-app/routers/\n\tcreate\t /Users/beeuser/learn/my-web-app/tests/\n\tcreate\t /Users/beeuser/learn/my-web-app/static/\n\tcreate\t /Users/beeuser/learn/my-web-app/static/js/\n\tcreate\t /Users/beeuser/learn/my-web-app/static/css/\n\tcreate\t /Users/beeuser/learn/my-web-app/static/img/\n\tcreate\t /Users/beeuser/learn/my-web-app/views/\n\tcreate\t /Users/beeuser/learn/my-web-app/conf/app.conf\n\tcreate\t /Users/beeuser/learn/my-web-app/controllers/default.go\n\tcreate\t /Users/beeuser/learn/my-web-app/views/index.tpl\n\tcreate\t /Users/beeuser/learn/my-web-app/routers/router.go\n\tcreate\t /Users/beeuser/learn/my-web-app/tests/default_test.go\n\tcreate\t /Users/beeuser/learn/my-web-app/main.go\n2020/09/14 22:28:51 SUCCESS  ▶ 0003 New application successfully created!\n```\n\nFor more information on the usage, run `bee help new`.\n\n### bee run\n\nTo run the application we just created, you can navigate to the application folder and execute:\n\n```bash\n$ cd my-web-app \u0026\u0026 bee run\n```\n\nFor more information on the usage, run `bee help run`.\n\n### bee pack\n\nTo compress a Beego application into a single deployable file:\n\n```bash\n$ bee pack\n______\n| ___ \\\n| |_/ /  ___   ___\n| ___ \\ / _ \\ / _ \\\n| |_/ /|  __/|  __/\n\\____/  \\___| \\___| v2.0.0\n2016/12/26 22:29:29 INFO     ▶ 0001 Packaging application on '/home/beeuser/.go/src/github.com/user/my-web-app'...\n2016/12/26 22:29:29 INFO     ▶ 0002 Building application...\n2016/12/26 22:29:29 INFO     ▶ 0003 Using: GOOS=linux GOARCH=amd64\n2016/12/26 22:29:31 SUCCESS  ▶ 0004 Build Successful!\n2016/12/26 22:29:31 INFO     ▶ 0005 Writing to output: /home/beeuser/.go/src/github.com/user/my-web-app/my-web-app.tar.gz\n2016/12/26 22:29:31 INFO     ▶ 0006 Excluding relpath prefix: .\n2016/12/26 22:29:31 INFO     ▶ 0007 Excluding relpath suffix: .go:.DS_Store:.tmp\n2016/12/26 22:29:32 SUCCESS  ▶ 0008 Application packed!\n```\n\nFor more information on the usage, run `bee help pack`.\n\n### bee rs \nInspired by makefile / npm scripts.\n  Run script allows you to run arbitrary commands using Bee.\n  Custom commands are provided from the \"scripts\" object inside bee.json or Beefile.\n\n  To run a custom command, use: $ bee rs mycmd ARGS\n\n```bash\n$ bee help rs\n\nUSAGE\n  bee rs\n\nDESCRIPTION\n  Run script allows you to run arbitrary commands using Bee.\n  Custom commands are provided from the \"scripts\" object inside bee.json or Beefile.\n\n  To run a custom command, use: $ bee rs mycmd ARGS\n  \nAVAILABLE SCRIPTS\n  gtest\n      APP_ENV=test APP_CONF_PATH=$(pwd)/conf go test -v -cover\n  gtestall\n      APP_ENV=test APP_CONF_PATH=$(pwd)/conf go test -v -cover $(go list ./... | grep -v /vendor/)\n\n```\n\n*Run your scripts with:*\n```$ bee rs gtest tests/*.go```\n```$ bee rs gtestall```\n\n\n### bee api\n\nTo create a Beego API application:\n\n```bash\n$ bee api my-api\n______\n| ___ \\\n| |_/ /  ___   ___\n| ___ \\ / _ \\ / _ \\\n| |_/ /|  __/|  __/\n\\____/  \\___| \\___| v2.0.0\n2020/09/14 22:35:11 INFO     ▶ 0001 generate api project support go modules.\n2020/09/14 22:35:11 INFO     ▶ 0002 Creating API...\n\tcreate\t /Users/beeuser/code/learn/my-api/go.mod\n\tcreate\t /Users/beeuser/code/learn/my-api\n\tcreate\t /Users/beeuser/code/learn/my-api/conf\n\tcreate\t /Users/beeuser/code/learn/my-api/controllers\n\tcreate\t /Users/beeuser/code/learn/my-api/tests\n\tcreate\t /Users/beeuser/code/learn/my-api/conf/app.conf\n\tcreate\t /Users/beeuser/code/learn/my-api/models\n\tcreate\t /Users/beeuser/code/learn/my-api/routers/\n\tcreate\t /Users/beeuser/code/learn/my-api/controllers/object.go\n\tcreate\t /Users/beeuser/code/learn/my-api/controllers/user.go\n\tcreate\t /Users/beeuser/code/learn/my-api/tests/default_test.go\n\tcreate\t /Users/beeuser/code/learn/my-api/routers/router.go\n\tcreate\t /Users/beeuser/code/learn/my-api/models/object.go\n\tcreate\t /Users/beeuser/code/learn/my-api/models/user.go\n\tcreate\t /Users/beeuser/code/learn/my-api/main.go\n2020/09/14 22:35:11 SUCCESS  ▶ 0003 New API successfully created!\n```\n\nFor more information on the usage, run `bee help api`.\n\n### bee hprose\n\nTo create an Hprose RPC application based on Beego:\n\n```bash\n$ bee hprose my-rpc-app\n______\n| ___ \\\n| |_/ /  ___   ___\n| ___ \\ / _ \\ / _ \\\n| |_/ /|  __/|  __/\n\\____/  \\___| \\___| v2.0.0\n2020/09/14 22:36:39 INFO     ▶ 0001 generate api project support go modules.\n2020/09/14 22:36:39 INFO     ▶ 0002 Creating Hprose application...\n\tcreate\t /Users/beeuser/code/learn/my-rpc-app/go.mod\n\tcreate\t /Users/beeuser/code/learn/my-rpc-app\n\tcreate\t /Users/beeuser/code/learn/my-rpc-app/conf\n\tcreate\t /Users/beeuser/code/learn/my-rpc-app/conf/app.conf\n\tcreate\t /Users/beeuser/code/learn/my-rpc-app/models\n\tcreate\t /Users/beeuser/code/learn/my-rpc-app/models/object.go\n\tcreate\t /Users/beeuser/code/learn/my-rpc-app/models/user.go\n\tcreate\t /Users/beeuser/code/learn/my-rpc-app/main.go\n2020/09/14 22:36:39 SUCCESS  ▶ 0003 New Hprose application successfully created!\n```\n\nFor more information on the usage, run `bee help hprose`.\n\n### bee bale\n\nTo pack all the static files into Go source files:\n\n```bash\n$ bee bale\n______\n| ___ \\\n| |_/ /  ___   ___\n| ___ \\ / _ \\ / _ \\\n| |_/ /|  __/|  __/\n\\____/  \\___| \\___| v2.0.0\n2020/09/14 22:37:56 SUCCESS  ▶ 0001 Baled resources successfully!\n```\n\nFor more information on the usage, run `bee help bale`.\n\n### bee migrate\n\nFor database migrations, use `bee migrate`.\n\nFor more information on the usage, run `bee help migrate`.\n\n### bee generate\n\nBee also comes with a source code generator which speeds up the development.\n\nFor example, to generate a new controller named `hello`:\n\n```bash\n$ bee generate controller hello\n______\n| ___ \\\n| |_/ /  ___   ___\n| ___ \\ / _ \\ / _ \\\n| |_/ /|  __/|  __/\n\\____/  \\___| \\___| v2.0.0\n2020/09/14 22:38:44 INFO     ▶ 0001 Using 'Hello' as controller name\n2020/09/14 22:38:44 INFO     ▶ 0002 Using 'controllers' as package name\n\tcreate\t /Users/beeuser/code/learn/my-api/controllers/hello.go\n2020/09/14 22:38:44 SUCCESS  ▶ 0003 Controller successfully generated!\n```\n\nFor more information on the usage, run `bee help generate`.\n\n### bee dockerize\n\nBee also helps you dockerize your Beego application by generating a Dockerfile and a docker-compose.yaml file.\n\nFor example, to generate a Dockerfile with `golang:1.20.1` baseimage and exposing port `9000`:\n\n```bash\n$ bee dockerize -baseimage=golang:1.20.1 -expose=9000\n______\n| ___ \\\n| |_/ /  ___   ___\n| ___ \\ / _ \\ / _ \\\n| |_/ /|  __/|  __/\n\\____/  \\___| \\___| v2.0.4\n2023/05/02 21:03:05 INFO     ▶ 0001 Generating Dockerfile and docker-compose.yaml...\n2023/05/02 21:03:05 SUCCESS  ▶ 0002 Dockerfile generated.\n2023/05/02 21:03:05 SUCCESS  ▶ 0003 docker-compose.yaml generated.\n```\n\nFor more information on the usage, run `bee help dockerize`.\n\n### bee dlv\n\nBee can also help with debugging your application. To start a debugging session:\n\n```bash\n______\n| ___ \\\n| |_/ /  ___   ___\n| ___ \\ / _ \\ / _ \\\n| |_/ /|  __/|  __/\n\\____/  \\___| \\___| v2.0.0\n2020/09/14 22:40:12 INFO     ▶ 0001 Starting Delve Debugger...\nType 'help' for list of commands.\n(dlv) break main.main\nBreakpoint 1 set at 0x40100f for main.main() ./main.go:8\n\n(dlv) continue\n\u003e main.main() ./main.go:8 (hits goroutine(1):1 total:1) (PC: 0x40100f)\n     3:\timport (\n     4:\t\t_ \"github.com/user/myapp/routers\"\n     5:\t\tbeego \"github.com/beego/beego/v2/server/web\"\n     6:\t)\n     7:\t\n=\u003e   8:\tfunc main() {\n     9:\t\tbeego.Run()\n    10:\t}\n    11:\n```\n\nFor more information on the usage, run `bee help dlv`.\n\n### bee pro \n\n#### bee pro toml\n\nTo create a beegopro.toml file\n\n```bash\n$ bee pro toml\n2020/09/14 22:51:18 SUCCESS  ▶ 0001 Successfully created file beegopro.toml\n2020/09/14 22:51:18 SUCCESS  ▶ 0002 Toml successfully generated!\n```\n\n#### bee pro gen\n\nSource code generator by beegopro.toml\n\n```bash\n$ bee pro gen\n2020/09/14 23:01:13 INFO     ▶ 0001 Create /Users/beeuser/.beego/beego-pro Success!\n2020/09/14 23:01:13 INFO     ▶ 0002 git pull /Users/beeuser/.beego/beego-pro\n2020/09/14 23:01:15 INFO     ▶ 0003 Using 'example' as name\n2020/09/14 23:01:15 INFO     ▶ 0004 Using 'example' as package name from controllers\n2020/09/14 23:01:15 INFO     ▶ 0005 create file '/Users/beeuser/code/learn/my-web-app/controllers/bee_default_controller.go' from controllers\n2020/09/14 23:01:15 INFO     ▶ 0006 Using 'example' as name\n2020/09/14 23:01:15 INFO     ▶ 0007 Using 'example' as package name from controllers\n2020/09/14 23:01:15 INFO     ▶ 0008 create file '/Users/beeuser/code/learn/my-web-app/controllers/example.go' from controllers\n2020/09/14 23:01:15 INFO     ▶ 0009 Using 'example' as name\n2020/09/14 23:01:15 INFO     ▶ 0010 Using 'example' as package name from models\n2020/09/14 23:01:15 INFO     ▶ 0011 create file '/Users/beeuser/code/learn/my-web-app/models/bee_default_model.go' from models\n2020/09/14 23:01:15 INFO     ▶ 0012 Using 'example' as name\n2020/09/14 23:01:15 INFO     ▶ 0013 Using 'example' as package name from models\n2020/09/14 23:01:15 INFO     ▶ 0014 create file '/Users/beeuser/code/learn/my-web-app/models/example.go' from models\n2020/09/14 23:01:15 INFO     ▶ 0015 Using 'example' as name\n2020/09/14 23:01:15 INFO     ▶ 0016 Using 'example' as package name from routers\n2020/09/14 23:01:15 INFO     ▶ 0017 create file '/Users/beeuser/code/learn/my-web-app/routers/example.go' from routers\n2020/09/14 23:01:15 INFO     ▶ 0018 Using 'example' as name\n2020/09/14 23:01:15 INFO     ▶ 0019 Using 'example' as package name from example\n2020/09/14 23:01:15 INFO     ▶ 0020 create file '/Users/beeuser/code/learn/my-web-app/ant/src/pages/example/list.tsx' from example\n2020/09/14 23:01:15 INFO     ▶ 0021 Using 'example' as name\n2020/09/14 23:01:15 INFO     ▶ 0022 Using 'example' as package name from example\n2020/09/14 23:01:15 INFO     ▶ 0023 create file '/Users/beeuser/code/learn/my-web-app/ant/src/pages/example/formconfig.tsx' from example\n2020/09/14 23:01:15 INFO     ▶ 0024 Using 'example' as name\n2020/09/14 23:01:15 INFO     ▶ 0025 Using 'example' as package name from example\n2020/09/14 23:01:15 INFO     ▶ 0026 create file '/Users/beeuser/code/learn/my-web-app/ant/src/pages/example/create.tsx' from example\n2020/09/14 23:01:15 INFO     ▶ 0027 Using 'example' as name\n2020/09/14 23:01:15 INFO     ▶ 0028 Using 'example' as package name from example\n2020/09/14 23:01:15 INFO     ▶ 0029 create file '/Users/beeuser/code/learn/my-web-app/ant/src/pages/example/update.tsx' from example\n2020/09/14 23:01:15 INFO     ▶ 0030 Using 'example' as name\n2020/09/14 23:01:15 INFO     ▶ 0031 Using 'example' as package name from example\n2020/09/14 23:01:15 INFO     ▶ 0032 create file '/Users/beeuser/code/learn/my-web-app/ant/src/pages/example/info.tsx' from example\n2020/09/14 23:01:15 INFO     ▶ 0033 Using 'example' as name\n2020/09/14 23:01:15 INFO     ▶ 0034 Using 'example' as package name from sql\n2020/09/14 23:01:15 INFO     ▶ 0035 create file '/Users/beeuser/code/learn/my-web-app/sql/example_up.sql' from sql\n2020/09/14 23:01:15 INFO     ▶ 0036 2020/09/14 23:01:15 INFO     ▶ 0001 db exec info ./sql/example_up.sql\n2020/09/14 23:01:15 SUCCESS  ▶ 0002 Migration successfully generated!\n2020/09/14 23:01:15 INFO     ▶ 0037 Using 'example' as name\n2020/09/14 23:01:15 INFO     ▶ 0038 Using 'example' as package name from sql\n2020/09/14 23:01:15 INFO     ▶ 0039 create file '/Users/beeuser/code/learn/my-web-app/sql/example_down.sql' from sql\n2020/09/14 23:01:15 SUCCESS  ▶ 0040 Gen successfully generated!\n```\n\n#### \n## Shortcuts\n\nBecause you'll likely type these generator commands over and over, it makes sense to create aliases:\n\n```bash\n# Generator Stuff\nalias g:a=\"bee generate appcode\"\nalias g:m=\"bee generate model\"\nalias g:c=\"bee generate controller\"\nalias g:v=\"bee generate view\"\nalias g:mi=\"bee generate migration\"\n```\n\nThese can be stored , for example, in your `~/.bash_profile` or `~/.bashrc` files.\n\n## Help\n\nTo print more information on the usage of a particular command, use `bee help \u003ccommand\u003e`.\n\nFor instance, to get more information about the `run` command:\n\n```bash\n$ bee help run\nUSAGE\n  bee run [appname] [watchall] [-main=*.go] [-downdoc=true]  [-gendoc=true] [-vendor=true] [-e=folderToExclude]  [-tags=goBuildTags] [-runmode=BEEGO_RUNMODE]\n\nOPTIONS\n  -downdoc\n      Enable auto-download of the swagger file if it does not exist.\n\n  -e=[]\n      List of paths to exclude.\n\n  -gendoc\n      Enable auto-generate the docs.\n\n  -main=[]\n      Specify main go files.\n\n  -runmode\n      Set the Beego run mode.\n\n  -tags\n      Set the build tags. See: https://golang.org/pkg/go/build/\n\n  -vendor=false\n      Enable watch vendor folder.\n\nDESCRIPTION\n  Run command will supervise the filesystem of the application for any changes, and recompile/restart it.\n```\n\n## Contributing\nBug reports, feature requests and pull requests are always welcome.\n\nWe work on two branches: `master` for stable, released code and `develop`, a development branch.\nIt might be important to distinguish them when you are reading the commit history searching for a feature or a bugfix,\nor when you are unsure of where to base your work from when contributing.\n\n### Found a bug?\n\nPlease [submit an issue][new-issue] on GitHub and we will follow up.\nEven better, we would appreciate a [Pull Request][new-pr] with a fix for it!\n\n- If the bug was found in a release, it is best to base your work on `master` and submit your PR against it.\n- If the bug was found on `develop` (the development branch), base your work on `develop` and submit your PR against it.\n\nPlease follow the [Pull Request Guidelines][new-pr].\n\n### Want a feature?\n\nFeel free to request a feature by [submitting an issue][new-issue] on GitHub and open the discussion.\n\nIf you'd like to implement a new feature, please consider opening an issue first to talk about it.\nIt may be that somebody is already working on it, or that there are particular issues that you should be aware of\nbefore implementing the change. If you are about to open a Pull Request, please make sure to follow the [submissions guidelines][new-pr].\n\n## Submission Guidelines\n\n### Submitting an issue\n\nBefore you submit an issue, search the archive, maybe you will find that a similar one already exists.\n\nIf you are submitting an issue for a bug, please include the following:\n\n- An overview of the issue\n- Your use case (why is this a bug for you?)\n- The version of `bee` you are running (include the output of `bee version`)\n- Steps to reproduce the issue\n- Eventually, logs from your application.\n- Ideally, a suggested fix\n\nThe more information you give us, the more able to help we will be!\n\n### Submitting a Pull Request\n\n- First of all, make sure to base your work on the `develop` branch (the development branch):\n\n```\n  # a bugfix branch for develop would be prefixed by fix/\n  # a bugfix branch for master would be prefixed by hotfix/\n  $ git checkout -b feature/my-feature develop\n```\n\n- Please create commits containing **related changes**. For example, two different bugfixes should produce two separate commits.\nA feature should be made of commits splitted by **logical chunks** (no half-done changes). Use your best judgement as to\nhow many commits your changes require.\n\n- Write insightful and descriptive commit messages. It lets us and future contributors quickly understand your changes\nwithout having to read your changes. Please provide a summary in the first line (50-72 characters) and eventually,\ngo to greater lengths in your message's body. A good example can be found in [Angular commit message format](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commit-message-format).\n\n- Please **include the appropriate test cases** for your patch.\n\n- Make sure all tests pass before submitting your changes.\n\n- Rebase your commits. It may be that new commits have been introduced on `develop`.\nRebasing will update your branch with the most recent code and make your changes easier to review:\n\n  ```\n  $ git fetch\n  $ git rebase origin/develop\n  ```\n\n- Push your changes:\n\n  ```\n  $ git push origin -u feature/my-feature\n  ```\n\n- Open a pull request against the `develop` branch.\n\n- If we suggest changes:\n  - Please make the required updates (after discussion if any)\n  - Only create new commits if it makes sense. Generally, you will want to amend your latest commit or rebase your branch after the new changes:\n\n    ```\n    $ git rebase -i develop\n    # choose which commits to edit and perform the updates\n    ```\n\n  - Re-run the tests\n  - Force push to your branch:\n\n    ```\n    $ git push origin feature/my-feature -f\n    ```\n\n[new-issue]: #submitting-an-issue\n[new-pr]: #submitting-a-pull-request\n\n## Licence\n\n```text\nCopyright 2020 bee authors\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeego%2Fbee","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeego%2Fbee","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeego%2Fbee/lists"}