Skip to content

Improve Contributing docs and set a release schedule#37109

Open
bircni wants to merge 10 commits intogo-gitea:mainfrom
bircni:improve_contrib
Open

Improve Contributing docs and set a release schedule#37109
bircni wants to merge 10 commits intogo-gitea:mainfrom
bircni:improve_contrib

Conversation

@bircni
Copy link
Copy Markdown
Member

@bircni bircni commented Apr 4, 2026

This PR updates CONTRIBUTING.md for clarity (code review, maintainers, PR workflow)

Suggestion

  • majors about every three months, with a more predictable cadence from v1.26 onward.
  • target dates such as v1.26.0 (April 2026), v1.27.0 (June 2026), v1.28.0 (September 2026), v1.29.0 (December 2026).
  • announce feature freeze two weeks before each release.

Other doc changes

  • Reviewing PRs: separate guidance for reviewers vs authors; small edits to maintaining PRs, merge queue, commit messages, co-authors.
  • Maintainers: clearer subsections; links to GitHub Docs for 2FA / GPG.
  • Split the Contributing.md into more useful markdown files

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Apr 4, 2026
@bircni bircni changed the title Improve contrib Improve Contributing docs and set a release schedule Apr 4, 2026
@bircni
Copy link
Copy Markdown
Member Author

bircni commented Apr 4, 2026

Replaces #36686

@wxiaoguang
Copy link
Copy Markdown
Contributor


By the way, I was thinking about splitting the CONTRIBUTING.md into different files.

There are too many contents mixed together in CONTRIBUTING.md, many of them are for maintainers only, not needed by contributors.

In my mind, some files:

  1. CONTRIBUTING.md: only contains the useful information for new contributors, and link to other files
  2. docs/guideline-frontend.md
  3. docs/guideline-backend.md
  4. docs/community-governance.md
  5. docs/release-management.md

Otherwise, the all-in-one file which has more than thousand of lines (wrapping....) is difficult to read, and the useful information can be easily ignored (for example: don't rebase+force-push)

@bircni
Copy link
Copy Markdown
Member Author

bircni commented Apr 5, 2026

By the way, I was thinking about splitting the CONTRIBUTING.md into different files.
There are too many contents mixed together in CONTRIBUTING.md, many of them are for maintainers only, not needed by contributors.
In my mind, some files:

  1. CONTRIBUTING.md: only contains the useful information for new contributors, and link to other files
  2. docs/guideline-frontend.md
  3. docs/guideline-backend.md
  4. docs/community-governance.md
  5. docs/release-management.md

Otherwise, the all-in-one file which has more than thousand of lines (wrapping....) is difficult to read, and the useful information can be easily ignored (for example: don't rebase+force-push)

Done

@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Apr 5, 2026
@bircni bircni requested review from lafriks and wxiaoguang April 5, 2026 17:30
@silverwind
Copy link
Copy Markdown
Member

We can do a slightly less-than-perfect 1.26.0 now, bug fixes will happen regardless and the more often we release, the easier they are to backport because branches diverge over time.

@silverwind
Copy link
Copy Markdown
Member

silverwind commented Apr 9, 2026

Maybe make it a bit less verbose overall, it seems quite big.

The plan is good, I hope it will be followed. We should also look into automating the release process as much as possible. Maybe with a release.sh script or similar. Currently there seem to be too many manual steps.

@bircni
Copy link
Copy Markdown
Member Author

bircni commented Apr 9, 2026

All this was nearly 100% copied into other files not fully reviewed again
Will recheck that all

@bircni bircni requested review from a team and a1012112796 April 10, 2026 16:36
@bircni
Copy link
Copy Markdown
Member Author

bircni commented Apr 10, 2026

@lunny @wxiaoguang @silverwind I added the following:

How is the release handled?

  • The release manager will tag the release candidate (e.g. v1.26.0-rc1) and publish it for testing in the first week of the release month.
  • If there are no major issues, the release manager will check with the other maintainers and then tag the final release (e.g. v1.26.0) in the one or two weeks following the release candidate.

I think it's ready for merge and to apply the new scheduling

@bircni bircni added the backport/v1.26 This PR should be backported to Gitea 1.26 label Apr 10, 2026
@DaanSelen
Copy link
Copy Markdown
Contributor

I like the idea!
I do also like the idea of instead of 1.x.x such as 1.26.1 why not do a date based version? 2026.01.patch? Or would that not fix? Its just my two cents.

@TheFox0x7
Copy link
Copy Markdown
Contributor

Ref issue for version numbering: #27574
It's really not in scope of this I feel.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport/v1.26 This PR should be backported to Gitea 1.26 lgtm/need 1 This PR needs approval from one additional maintainer to be merged. modifies/docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants