Contributing to Gitea
Thank you for your interest in contributing to Gitea! This guide will help you understand how to contribute to the project effectively.
Getting Started
Section titled “Getting Started”Before you start contributing, please read our Hacking on Gitea guide to set up your development environment.
Contribution Guidelines
Section titled “Contribution Guidelines”We have specific guidelines for different types of contributions:
Backend Development
Section titled “Backend Development”If you’re working on backend code (Go), please follow our Guidelines for Backend Development. This includes:
- Package design and dependencies
- Database operations and migrations
- Testing strategies
- Code organization
Frontend Development
Section titled “Frontend Development”For frontend contributions (JavaScript, CSS, Vue), refer to our Guidelines for Frontend Development. This covers:
- Framework usage (Vue3, Fomantic-UI)
- Code style and best practices
- Accessibility requirements
- TypeScript usage
Refactoring
Section titled “Refactoring”When refactoring existing code, follow our Guidelines for Refactoring to ensure:
- Clear refactoring objectives
- Proper review process
- Maintaining backward compatibility
- Incremental improvements
Localization
Section titled “Localization”To contribute translations or localization improvements, see our Localization Guide which explains:
- How to contribute translations via Crowdin
- Supported languages
- Translation workflow
Code of Conduct
Section titled “Code of Conduct”Please be respectful and constructive in all interactions with the community. We are committed to providing a welcoming and inclusive environment for all contributors.
Getting Help
Section titled “Getting Help”If you need help with your contribution:
- Join our Discord #Develop channel
- Visit our Forum
- Check existing GitHub Issues
Submitting Your Contribution
Section titled “Submitting Your Contribution”- Fork the repository
- Create a feature branch
- Make your changes following the relevant guidelines
- Write tests for your changes
- Ensure all tests pass
- Submit a pull request
For more details, see our CONTRIBUTING.md in the main repository.
Thank you for helping make Gitea better!