From 5ba836a35bb42e9dec152b22b48b167e1e09f5f9 Mon Sep 17 00:00:00 2001 From: Minecon724 Date: Wed, 4 Jun 2025 20:47:31 +0200 Subject: [PATCH 1/3] Add fork info to README --- README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 73 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f95aebadeb..cfd58cf4b1 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,13 @@ If you like any of the following, Forgejo is literally meant for you: - Federation: (WIP) We are actively working to connect software forges with each other through **ActivityPub**, and create a collaborative network of personal instances. -## Learn more +## What does this fork offer over vanilla Forgejo? + +Features are now tracked by Pull Requests, [see those here](https://git.m724.eu/git724/forgejo/pulls). + +## Learn more about Forgejo Dive into the [documentation](https://forgejo.org/docs/latest/), subscribe to releases and blog post on [our website](https://forgejo.org), find us on the Fediverse or hop into [our Matrix room](https://matrix.to/#/#forgejo-chat:matrix.org) if you have any questions or want to get involved. - ## License Forgejo is distributed under the terms of the [GPL version 3.0](LICENSE) or any later version. @@ -44,3 +47,71 @@ The agreement for this license [was documented in June 2023](https://codeberg.or ## Get involved If you are interested in making Forgejo better, either by reporting a bug or by changing the governance, please [take a look at the contribution guide](CONTRIBUTING.md). + + + +## For developers + +Consider the below an appendix to the valuable [official *Forgejo Contributor Guide*](https://forgejo.org/docs/next/contributor). + +For any development work, it's recommended to use the devcontainer. + +### Building + +Build a single image for multiple architectures: + +1. Setup: (do this once) + + ```bash + docker buildx create --name mybuilder --use + docker buildx inspect --bootstrap + docker run --privileged --rm tonistiigi/binfmt --install all + ``` + +2. Build: + + ```bash + docker buildx build --platform linux/amd64,linux/arm64 -t user/repo:tag --push . + ``` + + Replace the tag. You can add more architectures, if you wish. + +For non-Docker builds, [use the official instructions](https://forgejo.org/docs/next/contributor/from-source/). + +### Live reload + +Live reload make it easy to view changes. + +```bash +TAGS='sqlite sqlite_unlock_notify' make watch +``` + +It's still recommended to restart whenever it's convenient, or making a bigger change. + +### Merge + +Merging changes from vanilla. + +Make sure you checked out the branch to merge to. + +1. Add the upstream repository, if you haven't already: + ```bash + git remote add upstream https://codeberg.org/forgejo/forgejo.git + ``` + +2. Fetch changes: (note: `--no-tags` is necessary) + ```bash + git fetch --no-tags upstream + ``` + +3. Merge the changes into the fork: + ```bash + git merge upstream/$BRANCH + ``` + +### Tag a release + +``` +git tag $TAG +git push origin tag $TAG +``` From ac9deb773f986b29048bc22692439492ac4dea70 Mon Sep 17 00:00:00 2001 From: Minecon724 Date: Wed, 4 Jun 2025 20:49:37 +0200 Subject: [PATCH 2/3] Move development tips to CONTRIBUTING.mf --- CONTRIBUTING.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++ README.md | 68 ------------------------------------------------- 2 files changed, 66 insertions(+), 68 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 18b613d3bd..f897c4e935 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,3 +5,69 @@ The Forgejo project is run by a community of people who are expected to follow t Sensitive security-related issues should be reported to [security@forgejo.org](mailto:security@forgejo.org) using [encryption](https://keyoxide.org/security@forgejo.org). You can find links to the different aspects of Developer documentation on this page: [Forgejo Contributor Guide](https://forgejo.org/docs/next/contributor/). + +## For developers + +Consider the below an appendix to the valuable [official *Forgejo Contributor Guide*](https://forgejo.org/docs/next/contributor). + +For any development work, it's recommended to use the devcontainer. + +### Building + +Build a single image for multiple architectures: + +1. Setup: (do this once) + + ```bash + docker buildx create --name mybuilder --use + docker buildx inspect --bootstrap + docker run --privileged --rm tonistiigi/binfmt --install all + ``` + +2. Build: + + ```bash + docker buildx build --platform linux/amd64,linux/arm64 -t user/repo:tag --push . + ``` + + Replace the tag. You can add more architectures, if you wish. + +For non-Docker builds, [use the official instructions](https://forgejo.org/docs/next/contributor/from-source/). + +### Live reload + +Live reload make it easy to view changes. + +```bash +TAGS='sqlite sqlite_unlock_notify' make watch +``` + +It's still recommended to restart whenever it's convenient, or making a bigger change. + +### Merge + +Merging changes from vanilla. + +Make sure you checked out the branch to merge to. + +1. Add the upstream repository, if you haven't already: + ```bash + git remote add upstream https://codeberg.org/forgejo/forgejo.git + ``` + +2. Fetch changes: (note: `--no-tags` is necessary) + ```bash + git fetch --no-tags upstream + ``` + +3. Merge the changes into the fork: + ```bash + git merge upstream/$BRANCH + ``` + +### Tag a release + +``` +git tag $TAG +git push origin tag $TAG +``` diff --git a/README.md b/README.md index cfd58cf4b1..d7c87c414b 100644 --- a/README.md +++ b/README.md @@ -47,71 +47,3 @@ The agreement for this license [was documented in June 2023](https://codeberg.or ## Get involved If you are interested in making Forgejo better, either by reporting a bug or by changing the governance, please [take a look at the contribution guide](CONTRIBUTING.md). - - - -## For developers - -Consider the below an appendix to the valuable [official *Forgejo Contributor Guide*](https://forgejo.org/docs/next/contributor). - -For any development work, it's recommended to use the devcontainer. - -### Building - -Build a single image for multiple architectures: - -1. Setup: (do this once) - - ```bash - docker buildx create --name mybuilder --use - docker buildx inspect --bootstrap - docker run --privileged --rm tonistiigi/binfmt --install all - ``` - -2. Build: - - ```bash - docker buildx build --platform linux/amd64,linux/arm64 -t user/repo:tag --push . - ``` - - Replace the tag. You can add more architectures, if you wish. - -For non-Docker builds, [use the official instructions](https://forgejo.org/docs/next/contributor/from-source/). - -### Live reload - -Live reload make it easy to view changes. - -```bash -TAGS='sqlite sqlite_unlock_notify' make watch -``` - -It's still recommended to restart whenever it's convenient, or making a bigger change. - -### Merge - -Merging changes from vanilla. - -Make sure you checked out the branch to merge to. - -1. Add the upstream repository, if you haven't already: - ```bash - git remote add upstream https://codeberg.org/forgejo/forgejo.git - ``` - -2. Fetch changes: (note: `--no-tags` is necessary) - ```bash - git fetch --no-tags upstream - ``` - -3. Merge the changes into the fork: - ```bash - git merge upstream/$BRANCH - ``` - -### Tag a release - -``` -git tag $TAG -git push origin tag $TAG -``` From 5fa9729ecd84a287b942f4301b14247338b8086f Mon Sep 17 00:00:00 2001 From: Minecon724 Date: Wed, 4 Jun 2025 20:50:19 +0200 Subject: [PATCH 3/3] Re-add space removed in mistake --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index d7c87c414b..d3bb4e2d91 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,7 @@ Features are now tracked by Pull Requests, [see those here](https://git.m724.eu/ ## Learn more about Forgejo Dive into the [documentation](https://forgejo.org/docs/latest/), subscribe to releases and blog post on [our website](https://forgejo.org), find us on the Fediverse or hop into [our Matrix room](https://matrix.to/#/#forgejo-chat:matrix.org) if you have any questions or want to get involved. + ## License Forgejo is distributed under the terms of the [GPL version 3.0](LICENSE) or any later version.