No description
This repository has been archived on 2024-01-04. You can view files and clone it, but cannot push or open issues or pull requests.
Find a file
Yarden Shoham 0ac3be1482
Improve accessibility for issue comments (#22612) (#23083)
Backport #22612

### Preamble

Gitea is an extremely great and smart solution perfectly suitable for
smaller systems and self-hosted Git-powered setups. However, there is a
group of people who have indredible difficulties in using Gitea,
rendering it useless in many cases. Those people are blind developers
using [screen readers](https://en.wikipedia.org/wiki/Screen_reader).
Unfortunately, the frontend framework is super convoluted, and Go
templates don’t allow accessibility improvements in a straightforward
way. As a blind developer myself, I'm trying to start fixing smaller
accessibility quirks with intention to go deeper and eventually, alone
or not, make Gitea at least mostly accessible for screen reader users.

### What This Fix Does

My blind fellows and me navigate webpages not very similarly to how a
sighted person does it. For instance, we love semantic HTML markup like
headings, lists, tables etc. because our screen readers allow us to jump
by those landmarks with a single keypress.
Currently in Gitea issue comments are not marked up with headings. I'm
trying to fix this by adding an appropriate
[ARIA](https://www.w3.org/WAI/standards-guidelines/aria/) role for
comment header and also by enclosing the comment itself in a semantical
article element.

Co-authored-by: Andre Polykanine <ap@oire.me>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: John Olheiser <john.olheiser@gmail.com>
2023-02-23 16:32:15 +08:00
.gitea Issue template form (#16349) 2021-09-15 20:33:13 +03:00
.github Improve pull_request_template.md (#22888) 2023-02-20 19:14:02 -05:00
assets Use import of OCI structs (#22765) 2023-02-06 10:07:09 +00:00
build Consume hcaptcha and pwn deps (#22610) 2023-01-29 09:49:51 -06:00
cmd Refactor the setting to make unit test easier (#22405) 2023-02-20 00:12:01 +08:00
contrib Add Bash and Zsh completion scripts (#22646) 2023-02-21 12:32:24 -05:00
custom/conf Add Chef package registry (#22554) 2023-02-06 09:49:21 +08:00
docker Wrap unless-check in docker manifests (#23079) (#23081) 2023-02-23 01:34:47 +01:00
docs Changelog 1.18.5 (#23045) (#23049) 2023-02-21 13:36:19 -06:00
models Fix intermittent panic in notify issue change content (#23019) 2023-02-20 19:15:49 -05:00
modules Use --message=%s for git commit message (#23028) 2023-02-21 14:12:57 +08:00
options Add scopes to API to create token and display them (#22989) 2023-02-20 15:28:44 -06:00
public Add Chef package registry (#22554) 2023-02-06 09:49:21 +08:00
routers Add force_merge to merge request and fix checking mergable (#23010) 2023-02-21 08:42:07 -06:00
services Return empty url for submodule tree entries (#23043) 2023-02-21 12:31:17 -05:00
snap Remove unnecessary whitespace in snapcraft.yaml (#22090) 2022-12-10 08:31:16 -06:00
templates Improve accessibility for issue comments (#22612) (#23083) 2023-02-23 16:32:15 +08:00
tests Fix hidden commit status on multiple checks (#22889) 2023-02-20 16:43:04 +08:00
tools Move fuzz tests into tests/fuzz (#22376) 2023-01-09 15:30:14 +08:00
web_src Fix some more hidden problems (#23074) (#23075) 2023-02-22 15:26:48 +00:00
.air.toml Add more test directory to exclude dir of air, remove watching templates from air include dir because gitea has internal mechanism (#22246) 2022-12-27 14:00:34 +08:00
.changelog.yml Changelog for v1.15.0-rc1 (#16422) 2021-07-15 11:47:57 -04:00
.dockerignore Add .dockerignore (#21753) 2022-11-10 04:04:09 +01:00
.drone.yml only trigger docs build and publish when docs changed (#22968) 2023-02-20 21:08:41 +08:00
.editorconfig Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.eslintrc.yaml Refactor hiding-methods, remove jQuery show/hide, remove .hide class, remove inline style=display:none (#22950) 2023-02-19 12:06:14 +08:00
.gitattributes Hook go-licenses into tidy again (#21353) 2022-10-10 20:45:02 +02:00
.gitignore Add go licenses to licenses.txt (#21034) 2022-09-04 00:20:46 +02:00
.gitpod.yml Split default gitpod view to include all tasks (#22555) 2023-01-20 13:46:33 -06:00
.golangci.yml Fix .golangci.yml (#22868) 2023-02-11 21:44:53 +00:00
.ignore Add some .ignore entries (#18296) 2022-01-16 17:26:15 +00:00
.lgtm
.markdownlint.yaml Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.npmrc Stop packaging node_modules in release tarballs (#15273) 2021-04-09 01:08:14 -04:00
.spectral.yaml Add spectral linter for Swagger (#20321) 2022-07-11 18:07:16 -05:00
.stylelintrc.yaml Upgrade to stylelint 15 (#22944) 2023-02-21 09:23:45 -06:00
BSDmakefile Add BSDmakefile to prevent errors when make is called under FreeBSD (#4446) 2018-07-16 20:45:51 +02:00
build.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
CHANGELOG.md Changelog 1.18.5 (#23045) (#23049) 2023-02-21 13:36:19 -06:00
CONTRIBUTING.md Improving CONTRIBUTING.md for backport details (#23057) 2023-02-22 11:49:52 +08:00
DCO Remove address from DCO (#22595) 2023-01-24 18:52:38 +00:00
Dockerfile Add Bash and Zsh completion scripts (#22646) 2023-02-21 12:32:24 -05:00
Dockerfile.rootless Add Bash and Zsh completion scripts (#22646) 2023-02-21 12:32:24 -05:00
go.mod Bump golang.org/x/net from 0.4.0 to 0.7.0 (#22980) 2023-02-20 23:52:21 +08:00
go.sum Bump golang.org/x/net from 0.4.0 to 0.7.0 (#22980) 2023-02-20 23:52:21 +08:00
LICENSE
main.go Add Bash and Zsh completion scripts (#22646) 2023-02-21 12:32:24 -05:00
MAINTAINERS Add sillyguodong to maintainers (#23067) 2023-02-22 18:32:00 +08:00
Makefile update to build with go1.20 (#22732) 2023-02-03 11:23:52 -05:00
package-lock.json Upgrade to stylelint 15 (#22944) 2023-02-21 09:23:45 -06:00
package.json Upgrade to stylelint 15 (#22944) 2023-02-21 09:23:45 -06:00
playwright.config.js Update JS dependencies and eslint config (#21388) 2022-10-10 20:02:20 +08:00
README.md link update in README files (#22582) 2023-01-23 15:57:57 -05:00
README_ZH.md link update in README files (#22582) 2023-01-23 15:57:57 -05:00
SECURITY.md Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
vitest.config.js Update JS dependencies and eslint (#22190) 2022-12-20 17:15:47 -05:00
webpack.config.js Introduce customized HTML elements, fix incorrect AppUrl usages in templates (#22861) 2023-02-17 22:02:20 +08:00

Gitea

Gitea - Git with a cup of tea

Contribute with Gitpod

View this document in Chinese

Purpose

The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service.

As Gitea is written in Go, it works across all the platforms and architectures that are supported by Go, including Linux, macOS, and Windows on x86, amd64, ARM and PowerPC architectures. You can try it out using the online demo. This project has been forked from Gogs since November of 2016, but a lot has changed.

Building

From the root of the source tree, run:

TAGS="bindata" make build

or if SQLite support is required:

TAGS="bindata sqlite sqlite_unlock_notify" make build

The build target is split into two sub-targets:

  • make backend which requires Go Stable, required version is defined in go.mod.
  • make frontend which requires Node.js LTS or greater and Internet connectivity to download npm dependencies.

When building from the official source tarballs which include pre-built frontend files, the frontend target will not be triggered, making it possible to build without Node.js and Internet connectivity.

Parallelism (make -j <num>) is not supported.

More info: https://docs.gitea.io/en-us/install-from-source/

Using

./gitea web

NOTE: If you're interested in using our APIs, we have experimental support with documentation.

Contributing

Expected workflow is: Fork -> Patch -> Push -> Pull Request

NOTES:

  1. YOU MUST READ THE CONTRIBUTORS GUIDE BEFORE STARTING TO WORK ON A PULL REQUEST.
  2. If you have found a vulnerability in the project, please write privately to security@gitea.io. Thanks!

Translating

Translations are done through Crowdin. If you want to translate to a new language ask one of the managers in the Crowdin project to add a new language there.

You can also just create an issue for adding a language or ask on discord on the #translation channel. If you need context or find some translation issues, you can leave a comment on the string or ask on Discord. For general translation questions there is a section in the docs. Currently a bit empty but we hope to fill it as questions pop up.

https://docs.gitea.io/en-us/translation-guidelines/

Crowdin

Further information

For more information and instructions about how to install Gitea, please look at our documentation. If you have questions that are not covered by the documentation, you can get in contact with us on our Discord server or create a post in the discourse forum.

We maintain a list of Gitea-related projects at gitea/awesome-gitea.

The Hugo-based documentation theme is hosted at gitea/theme.

The official Gitea CLI is developed at gitea/tea.

Authors

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

FAQ

How do you pronounce Gitea?

Gitea is pronounced /ɡɪti:/ as in "gi-tea" with a hard g.

Why is this not hosted on a Gitea instance?

We're working on it.

License

This project is licensed under the MIT License. See the LICENSE file for the full license text.

Screenshots

Looking for an overview of the interface? Check it out!

Dashboard User Profile Global Issues
Branches Web Editor Activity
New Migration Migrating Pull Request View
Pull Request Dark Diff Review Dark Diff Dark