This document describes requirements and best practices for contributing code (Pull Request) to Gogs project.
If you have/find any concern/problem with this document, DO NOT create an issue in this repository, instead, please go to Gitter and discuss.
Before You Start
Those We Do Accept
- Typos in template files or code comments.
- Bug fixes or feature implementations (be sure to discuss first).
- Issues that are labeled as help wanted (be sure to claim first to prevent two people work on the same thing).
Those We Do Not Accept
- We do not accept pull requests for locale files (
conf/locale_xx-XX.inifiles), please read the guide, except for
- Docker compose file.
- Pull request with a lot of changed files; we have rights to deny any pull requests that we considered too large to take time to review.
Make A Claim
Write a comment to the corresponding thread to claim you're working on it, so people wouldn't have conflict on what they're working on.
- Please follow the general Go Code Convention and Gogs Coding Guidelines.
.gofiles must be formatted with
gofmt(most of Go editors should be already possible to format on save).
.tmplfiles must use 1 tab as indention.
NO modifications to
.cssfiles should be done by hand,
.cssfiles are all generated by
.lessfiles. Normally you can achieve this by executing
For UI Changes
- Please use standard Semantic UI classes as much as possible to avoid editing
- Please attach corresponding screenshots for all representative pages that is affected by your changes.
- If you need to add new locale strings, you ONLY need to care about
conf/locale_en-US.inifile, DO NOT touch all the other locales files.
- There is no guarantees that your pull request will be merged.
- Currently, ALL pull requests must be sent to
- Code review is VERY strict, please be prepared for benefiting future of this project.