diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 3810b1b0f..606deeeae 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -21,6 +21,7 @@ In addition to the general guides with open source contributions, you would also - Have basic knowledge about web applications development, database management systems and programming in [Go](https://go.dev/). - Have a working local development setup with a reasonable good IDE or editor like [Visual Studio Code](https://code.visualstudio.com/docs/languages/go), [GoLand](https://www.jetbrains.com/go/) or [Vim](https://github.com/fatih/vim-go). +- [Set up your development environment](/docs/dev/local_development.md). ## Issues diff --git a/README.md b/README.md index 642c42611..8728a70ac 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,9 @@ The Gogs (`/gɑgz/`) project aims to build a simple, stable and extensible self- - Please visit [our home page](https://gogs.io) for user documentation. - Please refer to [CHANGELOG.md](CHANGELOG.md) for list of changes in each releases. - Want to try it before doing anything else? Do it [online](https://try.gogs.io/gogs/gogs)! -- Having trouble? Help yourself with [troubleshooting](https://gogs.io/docs/intro/troubleshooting.html) or ask questions on [user forum](https://discuss.gogs.io/). +- Having trouble? Help yourself with [troubleshooting](https://gogs.io/docs/intro/troubleshooting.html) or ask questions in [Discussions](https://github.com/gogs/gogs/discussions). - Want to help with localization? Check out the [localization documentation](https://gogs.io/docs/features/i18n.html). -- Ready to get hands dirty? Read our guide to [set up your development environment](docs/dev/local_development.md). +- Ready to get hands dirty? Read our [contributing guide](.github/contributing.md). - Hmm... What about APIs? We have experimental support with [documentation](https://github.com/gogs/docs-api). ## 💌 Features diff --git a/docs/dev/local_development.md b/docs/dev/local_development.md index 07756f04e..7d1265e57 100644 --- a/docs/dev/local_development.md +++ b/docs/dev/local_development.md @@ -1,7 +1,5 @@ # Getting started with developing Gogs -> This document is driven from https://docs.sourcegraph.com/dev/local_development. - Gogs is written in [Go](https://golang.org/), please take [A Tour of Go](https://tour.golang.org/) if you haven't done so! ## Outline @@ -23,7 +21,7 @@ Gogs is built and runs as a single binary and meant to be cross platform. Theref Gogs has the following dependencies: - [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) (v1.8.3 or higher) -- [Go](https://golang.org/doc/install) (v1.14 or higher) +- [Go](https://golang.org/doc/install) (v1.15 or higher) - [Less.js](http://lesscss.org/usage/#command-line-usage-installing) - [Task](https://github.com/go-task/task) - Database upon your choice (pick one, we choose PostgreSQL in this document): @@ -123,7 +121,7 @@ Generally, you don't need a full clone, so set `--depth` to `10`: git clone --depth 10 https://github.com/gogs/gogs.git ``` -**NOTE** The repository has Go Modules enabled, please clone to somewhere outside of your `$GOPATH`. +**NOTE** The repository has Go modules enabled, please clone to somewhere outside of your `$GOPATH`. ## Step 4: Configure database settings @@ -162,7 +160,7 @@ LOAD_ASSETS_FROM_DISK = true ### Offline development -Sometimes you will want to develop Gogs but it just so happens you will be on a plane or a train or perhaps a beach, and you will have no WiFi. And you may raise your fist toward heaven and say something like, "Why, we can put a man on the moon, so why can't we develop high-quality Git hosting without an Internet connection?" But lower your hand back to your keyboard and fret no further, for the year is 2020, and you *can* develop Gogs with no connectivity by setting the following configuration in your `custom/conf/app.ini`: +Sometimes you will want to develop Gogs but it just so happens you will be on a plane or a train or perhaps a beach, and you will have no WiFi. And you may raise your fist toward heaven and say something like, "Why, we can put a man on the moon, so why can't we develop high-quality Git hosting without an Internet connection?" But lower your hand back to your keyboard and fret no further, you *can* develop Gogs with no connectivity by setting the following configuration in your `custom/conf/app.ini`: ```ini [server] diff --git a/docs/dev/release/issue_template_minor_version.md b/docs/dev/release/issue_template_minor_version.md index c360d65b1..111db41a1 100644 --- a/docs/dev/release/issue_template_minor_version.md +++ b/docs/dev/release/issue_template_minor_version.md @@ -13,10 +13,10 @@ On release branch: - [ ] Update the [hard-coded version](https://github.com/gogs/gogs/blob/main/gogs.go#L21) to the current release, e.g. `0.12.0+dev` -> `0.12.0`. - [ ] Publish a new [GitHub release](https://github.com/gogs/gogs/releases) with entries from [CHANGELOG](https://github.com/gogs/gogs/blob/main/CHANGELOG.md) for the current release. -- [ ] Wait for a new [Docker Hub tag](https://hub.docker.com/r/gogs/gogs/tags) for the current release to be created automatically. +- [ ] Wait for a new image tag for the current release to be created automatically on both [Docker Hub](https://hub.docker.com/r/gogs/gogs/tags) and [GitHub Container registry](https://github.com/gogs/gogs/pkgs/container/gogs). - [ ] Push another Docker image tag as `.`, e.g. `0.12`. - [ ] Compile and pack binaries (all prefixed with `gogs_.._`, e.g. `gogs_0.12.0_`): - - [ ] macOS: `darwin_amd64.zip` + - [ ] macOS: `darwin_amd64.zip`, `darwin_arm64.zip` - [ ] Linux: `linux_386.tar.gz`, `linux_386.zip`, `linux_amd64.tar.gz`, `linux_amd64.zip` - [ ] ARM: `linux_armv7.tar.gz`, `linux_armv7.zip` - [ ] Windows: `windows_amd64.zip`, `windows_amd64_mws.zip` @@ -31,7 +31,7 @@ On release branch: On develop branch: - [ ] Update the repository mirror on [Gitee](https://gitee.com/unknwon/gogs). -- [ ] Create a new release topic on [Gogs Discussion](https://discuss.gogs.io/c/announcements/5). +- [ ] Create a new release announcement in [Discussions](https://github.com/gogs/gogs/discussions/categories/announcements). - [ ] Send out release announcement emails via [Mailchimp](https://mailchimp.com/). - [ ] Publish a new release article on [OSChina](http://my.oschina.net/Obahua/admin/releases). - [ ] Update the [hard-coded version](https://github.com/gogs/gogs/blob/main/gogs.go#L21) to the new develop version, e.g. `0.12.0+dev` -> `0.13.0+dev`. diff --git a/docs/dev/release/issue_template_patch_release.md b/docs/dev/release/issue_template_patch_release.md index 60bff854a..16989ffe0 100644 --- a/docs/dev/release/issue_template_patch_release.md +++ b/docs/dev/release/issue_template_patch_release.md @@ -17,10 +17,10 @@ On release branch: ``` **ℹ️ Heads up! There is a new patch release [0.12.1](https://github.com/gogs/gogs/releases/tag/v0.12.1) available, we recommend directly installing or upgrading to that version.** ``` -- [ ] Wait for a new [Docker Hub tag](https://hub.docker.com/r/gogs/gogs/tags) for the current release to be created automatically. +- [ ] Wait for a new image tag for the current release to be created automatically on both [Docker Hub](https://hub.docker.com/r/gogs/gogs/tags) and [GitHub Container registry](https://github.com/gogs/gogs/pkgs/container/gogs). - [ ] Update Docker image tag for the minor release `.`, e.g. `0.12`. - [ ] Compile and pack binaries (all prefixed with `gogs_.._`, e.g. `gogs_0.12.0_`): - - [ ] macOS: `darwin_amd64.zip` + - [ ] macOS: `darwin_amd64.zip`, `darwin_arm64.zip` - [ ] Linux: `linux_386.tar.gz`, `linux_386.zip`, `linux_amd64.tar.gz`, `linux_amd64.zip` - [ ] ARM: `linux_armv7.tar.gz`, `linux_armv7.zip`, `linux_armv8.tar.gz`, `linux_armv8.zip` - [ ] Windows: `windows_amd64.zip`, `windows_amd64_mws.zip` @@ -39,5 +39,5 @@ On develop branch: The .. has been released. ``` - [ ] Update the repository mirror on [Gitee](https://gitee.com/unknwon/gogs). -- [ ] Reply to the release topic for the minor release on [Gogs Discussion](https://discuss.gogs.io/c/announcements/5). +- [ ] Reply to the release topic for the minor release in [Discussions](https://github.com/gogs/gogs/discussions/categories/announcements). - [ ] Close the patch milestone.