The file CONTRIBUTING.md contains a list of links that points to
different parts of the developer documentation.
Unfortunately, this list is now incomplete and contains a dead link for the
Developer Workflow.
Given that a more complete similar list is present at:
https://forgejo.org/docs/latest/developer/, this patch removes the
duplication of information, which leads to dead links and
maintenance burden, and replaces the list with simply a link to the page
that has all the current links.
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/3454
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Nicolas CARPi <nico-git@deltablot.email>
Co-committed-by: Nicolas CARPi <nico-git@deltablot.email>
Refs: https://codeberg.org/forgejo/forgejo/issues/8
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/153
Refs: https://codeberg.org/forgejo/forgejo/issues/123
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/299
(cherry picked from commit 08dcef0c8cc9cdf5d786a925f18c1ec0cf3364da)
[DOCS] CONTRIBUTING/RELEASE: https://forgejo.org/docs/admin
Because the version is not displayed on the landing page of Forgejo,
there cannot be a link to a versionned documentation. There must exist
a link that points to the latest version on the website for the
forgejo instance to display.
Better but more complicated approaches could be to:
* Embed the documentation in Forgejo
* Allow the admin to not display the help
* Allow the admin to display a versionned help or not
(cherry picked from commit 83cc38923935dcc7edca22756d6fc10988a58540)
(cherry picked from commit 5df52b8a4f6ebd184999a19dd10138a8e3980869)
(cherry picked from commit 9a66b3d70b6e7d2a3ee146d3708d48d8f9bfe305)
[DOCS] CONTRIBUTING/RELEASE: reminder to update FORGEJO_VERSION
(cherry picked from commit 2a4d0bd164e55fc981d9437d8220a9c1e00ca59b)
(cherry picked from commit d68576ba6762f4af2ed8133fe123fa84c136a90c)
[DOCS] CONTRIBUTING: updates
* Remove obsolete description of the well being & moderation team and
replace them with a link to the moderation email.
* Remove description of the governance process and replace with a link
to the governance readme that did not exist at the time.
* Add links to the Forgejo documentation
(cherry picked from commit df749da27225ee13b5e00b689b397b24afebd044)
(cherry picked from commit 4da39128c50e5e754f1404a5b79669a8218344be)
(cherry picked from commit f442ca6f4032bbd61185e488e5a513f4e4264559)
(cherry picked from commit 031928c447e4cbc293de03f6befbba05691810fc)
(cherry picked from commit 1e6ba47216f8cab267f555eb488f4e80ef503fcf)
(cherry picked from commit 8916a1f8c6358a85c2484a465a73a5d657fcb048)
(cherry picked from commit 663e28c41247e98b34cbd6cd32ce1b891f386989)
(cherry picked from commit d56b130baaa4dd13bc64f2f149753b7a2e40ae01)
[DOCS] CONTRIBUTING (squash)
(cherry picked from commit 0dc4b6e5c93e1abc1502149603839ebe30ab4e5a)
(cherry picked from commit 52f2163807abc5dcb35ebee32f695368be720105)
(cherry picked from commit 47d0ae3e10385b7568474c4f3cae1eb79961838b)
(cherry picked from commit 7757a5c34cd61bfc7a96766c6c55baba9d571c3f)
(cherry picked from commit 5b4d25bd037d9142fe274bfdeb6ac43cf371ae95)
(cherry picked from commit 78798cc25e90200474cb1051f97a97e2d8091568)
(cherry picked from commit 3001fb8c7b3eecd6935b3c66f87981d77c0c64d9)
(cherry picked from commit da27bf1bc5a3a4ee9b9bcbd34a9d81d503410de8)
(cherry picked from commit 2fb13da8ed918fce8cc3a4471aefaba78836ffa5)
(cherry picked from commit ea19e0efb33710f36cf2ca300424eca7301922a5)
[DOCS] Add link to build instructions in CONTRIBUTING.md
(cherry picked from commit 50d86aa4ad740938e6089fc7ebde231653da7f9e)
Replace 'v1.20' with 'next'
(cherry picked from commit 3e99f49fc5a9c104f2656a330d497c92368994fc)
(cherry picked from commit f5c89e88cfe05b4ecc753674a24284b2a2af634c)
(cherry picked from commit 8e70433dac072af935676dc42f41b1ef66a0eedd)
(cherry picked from commit 31cc99588c0d456beb0b8493f919b06df3782371)
fixes 404 links in CONTRIBUTING.md
(cherry picked from commit b7326919ab20feaf5650cfb8d284dc074b835e62)
(cherry picked from commit cd88e7d177101a9e3be9ef8c19f1220115ae3851)
(cherry picked from commit 09d33f2050aafe9ffdd8412b1eacdd8aa172dfd1)
(cherry picked from commit 8ea49fc0c7b693ae348738f63a8a6e82fbfeebdc)
(cherry picked from commit a434c76f4b30a376643e3716d14bd0514e9af364)
(cherry picked from commit c61e1b879717406586ea7c60d5fdea6782637e86)
(cherry picked from commit 1ce9dc9defc22837dedfb52f0e8fbf78719204c8)
(cherry picked from commit a90927d0b1b57f06625ef53c2860617f67608b92)
(cherry picked from commit 17ca38d29a63d691817a09d3c53dc29ce1b8d0e2)
(cherry picked from commit 70986dddc958c284a55eca2b8a758d2030a9aebe)
(cherry picked from commit 667b4e740734bbb69438021d6813249d65392fb1)
(cherry picked from commit dd3a3807780d1125c0b2ab2b47349577ca0073ca)
(cherry picked from commit a22b8979e5882a58fcb369408b505d031f491589)
(cherry picked from commit 87d1125ad00b0130e5b56f8b303f599f9d8fc6ef)
(cherry picked from commit df6ebcc40b742815413741453729cbd3145b3200)
(cherry picked from commit 9bac1dbf63c35a40e593e29c7a98e889fce6c3fb)
(cherry picked from commit dc5e1998b31c5acf342164f4723c417d4ad5dc14)
(cherry picked from commit 4c4878477edb8fa2653b94192a3980062d188140)
(cherry picked from commit 9adf97d004f412aeb1e25cf3a63f4509c54b6ba5)
(cherry picked from commit 3993bd23c4284766f04c4ace09cc4e92df59cdaa)
(cherry picked from commit 1e04d81657005b47cdb11d93006cd174b6b86f2c)
(cherry picked from commit 2aa2ff63f0ff09c7a048d415e7940dda16b2c373)
(cherry picked from commit d2326d8aa4c81e5b99f8bd4a7d587903111792d9)
(cherry picked from commit 85d91c420b17e7e62f4a22f950fa31c29c4be60b)
(cherry picked from commit 69a21774e96610b78c2f44305266324bf949a405)
Although it would be possible to modify these files, it would create
conflicts when rebasing. Instead, this commit removes them entirely
and another commit can start from scratch, borrowing content from the
original files.
The drawback of this approach is that some content updates from Gitea
that also need updating in Forgejo will have to be copy/pasted
instead of being merged.
(cherry picked from commit eb85782115f2f453e13561848925760b1abddb16)
(cherry picked from commit 34401f2004445f225a479b8258180f498ac87847)
(cherry picked from commit ef43b1c6910a01a5f9dbd054e23372f6f17f4d9e)
(cherry picked from commit d17fe25e2f915e778eb968c20939dc253f47bcd5)
(cherry picked from commit 3f65dea3e7a5d0983d96d7011385125bd0063ff1)
(cherry picked from commit 3cacb64a1bae713467d3d9b7ebfe626930f2bd35)
(cherry picked from commit b531b014b751233b46e3220c25108fe95531621b)
(cherry picked from commit adf6e7a840c7f7201eddec3ab2b305200b19fc43)
(cherry picked from commit 68c19d977d6aa8e8eb5714f5915b6557379887c0)
(cherry picked from commit 31aa8647ecaf91704652e149fb5d0e891645412d)
(cherry picked from commit be70dd7208c2b40842cb83affa77f6d15ac4d840)
(cherry picked from commit 7f44bb60b16843b0e127a7e5fc89736a1d35d145)
(cherry picked from commit 5098f1224b10ac7b35c1d4c9ece8fbd066a616e8)
(cherry picked from commit dc7a8591442772f9801bfff7a77f1c8806bedb5c)
(cherry picked from commit f1e78dd0067f8d0e9a6ea4dc292ebebdb8b8bcda)
(cherry picked from commit c41ba7a148d1b35df392a7d2af9a52461e1cb217)
(cherry picked from commit f1da66a918a68237894e220d206a5e0251ec85d0)
(cherry picked from commit 99194a3664dc94296f7e1397be45b6fde9e3e718)
(cherry picked from commit 52f356f6a9dbbbd4e2c68fde99f7c35a3e6f2bd0)
(cherry picked from commit c93ffa72ae35bbdc6cc470823648a1aed0185b5d)
(cherry picked from commit 477c7454d39e813e2bc5107bf84105060acfe743)
(cherry picked from commit 413df23a407547b1a0d480185be9efc388b464eb)
[DOCS] delete Gitea specific files that need rewriting for Forgejo (squash)
(cherry picked from commit df78cedd053e624bcc30b048eac9d6ab10ff5749)
(cherry picked from commit 3b9178b3e5ee1aedff79a6ff5b62fb700f480682)
(cherry picked from commit 9044dcb0e7bb410bbc8a83c8d3610fa6c8355e25)
(cherry picked from commit e138685bacc14138aad46bea2756dc4f6d6b46c0)
(cherry picked from commit 2f1f3fd6b8a7b054bf854ea94ef91c8f87bce996)
(cherry picked from commit 0b47d02df6c93129d825aa1b9d3f481b6cf7f505)
(cherry picked from commit 7625ca6c42b6a333e3a2e25dd3df2744a4180e32)
(cherry picked from commit e0d720a728cf24eaeb1416ac1c5b8de6655ccd44)
(cherry picked from commit 19aa974d120fe5ade8436e5ea0fab6a83f1b9db1)
(cherry picked from commit bb637d398cb02e2d0059a1e7660b88bfe87e3315)
(cherry picked from commit 5357fc952d29b5f38ad95b3c94fca22e16217578)
(cherry picked from commit bee03950445384c4d985617793175bb7b27810a1)
(cherry picked from commit 5e574bfc8f761ad631aaadda6fa4c44ac826153b)
(cherry picked from commit 9593225c5bfbf0ac5cddd62359c812b755995397)
(cherry picked from commit f6e5faee613947755c85807ab6b06fe8008aed9b)
(cherry picked from commit 02f2a9a47a9084a6218d67f773d474febbb5fa54)
(cherry picked from commit 68695685c1042e273800a4dad5f21cb009ac32ff)
(cherry picked from commit 9ae53997a4188a333021dfda42eb620213db2471)
(cherry picked from commit d87a6b4908290fb16188042048b50718bbe383ea)
(cherry picked from commit 891b628aa19efff43ad18dd45983887802e84e10)
(cherry picked from commit 0b290c23ea14d960732872cbf5c91177ddce11cc)
(cherry picked from commit 9cfae4f0aa4bf3b3175f64f93d3e5c66e785db56)
(cherry picked from commit bd811bcc18784f57840d6cae502e125770025c19)
(cherry picked from commit cf89915013cf0ef65065c191968b628a2a735729)
(cherry picked from commit 7a519b8ba4acc5ad47b59ff7cab67b1b3d08ae9c)
(cherry picked from commit 11283e0d37f083eacd6c548673654ad1624744b6)
(cherry picked from commit a1ca01f37f6d929f39f970d0cf23b88e44f61329)
(cherry picked from commit 15fd92924a4f50f818aa0b389d7869143172a353)
When writing the release blog, it is really annoying and time-consuming
to re-discover and write down how a feature behaves and capture a
screenshot of it, for every single feature merged since the last
release.
This should not be the responsibility of maintainers, but rather of the
person implementing a feature in the first place.
They know best how to use the feature and how to gather screenshots for
it.
Similarly for breaking changes and their effects.
As such, let's require everything to be up-to-date and easily
understandable before merging features or breaking changes.
Fixed typos considering CONTRIBUTING.md.
This line:
GitHub API compatability #github-api-compatability
changed to:
GitHub API compatibility #github-api-compatibility
and this line:
GitHub API compatability
changed to:
GitHub API compatibility
Previously, the `CONTRIBUTING` was severely outdated in certain aspects
such as workflows.
These sections have been brought up to date.
Furthermore, the `CONTRIBUTING` now mentions the TOC, how it is
structured, elected, and its duties.
---------
Signed-off-by: jolheiser <john.olheiser@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: Jason Song <i@wolfogre.com>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
Co-authored-by: delvh <dev.lh@web.de>
This PR provides a contributed backport command to help create backports
for Gitea.
It represents a significant improvement on my previously described
shell-script.
It can be installed using `go install contrib/backport/backport.go`.
Signed-off-by: Andrew Thornton <art27@cantab.net>
Change all license headers to comply with REUSE specification.
Fix #16132
Co-authored-by: flynnnnnnnnnn <flynnnnnnnnnn@github>
Co-authored-by: John Olheiser <john.olheiser@gmail.com>
Following a discord discussion from today I've written the policy
explained to me about keeping PRs up-to-date.
Signed-off-by: Yarden Shoham <hrsi88@gmail.com>
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
Some changes to the contribution guidelines.
- I removed the `Large Character Comments` part because I think they are
bad design. They are used in big files to group sections of code. This
code should be organized into individual files.
- Updated some paths.
- Added `Documentation` because our documentation is not good at the
moment. We should enforce documentation of newly added features to help
our users.
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Explain how to title your Backport PR
* Advise that the first comment in a PR should explain the PR
* Include information about BREAKING changes
* Include information about backports/frontports
* Add reference command for creating backports
* Add reference commandline for creating large characters
* Add information about updating docs/config.yaml
* Update year in the copyright
Signed-off-by: Andrew Thornton <art27@cantab.net>
* Add info about list endpoints to CONTRIBUTING.md
* Let all list endpoints return X-Total-Count header
* Add TODOs for GetCombinedCommitStatusByRef
* Fix models/issue_stopwatch.go
* Rrefactor models.ListDeployKeys
* Introduce helper func and use them for SetLinkHeader related func
* Change the release cycle to match actual situations
* Update CONTRIBUTING.md
Co-authored-by: zeripath <art27@cantab.net>
Co-authored-by: Lauris BH <lauris@nix.lv>
* docs: update 'Testing redux' in CONTRIBUTING.md
try simplfy it to make it more easy for contributor to follow it to
test their work by themselves.
Signed-off-by: a1012112796 <1012112796@qq.com>
* align help message strings
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
- added new 'make webpack' target
- deprecated 'make js' and 'make css'
- extend webpack config to load the less files
- updated docs
I had to rename the source file of `arc-green.less` to avoid generating
a useless JS entrypoint via webpack-fix-style-only-entries which would
not work with different source/destination filenames. I hear that there
should be cleaner solutions possible once we upgrade to Webpack 5.
Co-authored-by: zeripath <art27@cantab.net>
* More information for drone-cli in CONTRIBUTING.md
* Increases the version of drone-cli to 1.2.0
* Adds a note for the Docker Toolbox on Windows
Signed-off-by: LukBukkit <luk.bukkit@gmail.com>
* Fix the url for the blog repository (now on gitea.com)
Signed-off-by: LukBukkit <luk.bukkit@gmail.com>
* add make targets for js,css, add javascript linter
- add `make js`, deprecating `make javascripts`
- add `make css`, deprecating `make generate-stylesheets` and
`make stylesheets-check`
- changed the unclean css check to only run on CI
- add JS linting via eslint with basic configuration and fixed
discovered issues
- changed autoprefixer to use official `postcss-cli` avoiding the need
to loop in the makefile
- moved browserslist to package.json so other future tools can use it
too.
- update documentation for new make targets and added JS section
* fix indentation
* move functions used in html to 'exported' list
* Run lessc binary without having to install anything to node_modules
* use relative paths to node bin scripts, removing npx
* Revert "use relative paths to node bin scripts, removing npx"
This reverts commit 119b725525a8430b32ee7a6e6009b4ece544e39b.
* fix lessc and postcss plugins
* check for node_modules and use actual bin names
* Migrate to go modules
* make vendor
* Update mvdan.cc/xurls
* make vendor
* Update code.gitea.io/git
* make fmt-check
* Update github.com/go-sql-driver/mysql
* make vendor
* add scripts/test-local.sh and fix CONTRIBUTING.md
- fixes #6243
- partial fix for #6269
Signed-off-by: Steve Traugott <stevegt@t7a.org>
* remove reference to possible automated drone run
* remove bash version of drone-cli test script
* fix issue number links in testing instructions
* remove scripts/test-local.sh
* Added Go Path and node_modules to PATH
* Uses npx now for generate-stylesheets
* Uses `go env GOPATH` to calculate adding GOPATH/bin to PATH
* Added note about installing Node 8.0+ to generate stylesheets
* Added preferred Node version to CONTRIBUTING.md
