USEFULL/gogs
1
0
Fork 0
mirror of https://github.com/gogs/gogs.git synced 2025-07-14 08:09:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Contributing Code (markdown)

ᴜɴᴋɴᴡᴏɴ 2020-02-22 13:18:42 +08:00
parent 55c1d6e081
commit a76678c402
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Contributing-Code.md

@ -2,38 +2,38 @@ This document describes requirements and best practices for contributing code (P
If you have/find any concern/problem with this document, **DO NOT** create an issue in this repository, instead, please go to [Gogs Discussion](https://discuss.gogs.io/) and discuss. If you have/find any concern/problem with this document, **DO NOT** create an issue in this repository, instead, please go to [Gogs Discussion](https://discuss.gogs.io/) and discuss.
### Before you start ## Before you start
#### Those we do accept ### Those we do accept
1. Typos in template files or code comments. 1. Typos in template files or code comments.
2. Bug fixes or feature implementations (be sure to discuss first). 2. Bug fixes or feature implementations (be sure to discuss first).
2. Issues that are labeled as [help wanted](https://github.com/gogs/gogs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) and [good first issue](https://github.com/gogs/gogs/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) (be sure to claim first to prevent two people work on the same thing!). 2. Issues that are labeled as [help wanted](https://github.com/gogs/gogs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) and [good first issue](https://github.com/gogs/gogs/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) (be sure to claim first to prevent two people work on the same thing!).
#### Those we do not accept ### Those we do not accept
1. We do not accept pull requests for locale files (`conf/locale_xx-XX.ini` files), please read the [guide](https://gogs.io/docs/features/i18n), except for `conf/locale_en-US.ini` file. 1. We do not accept pull requests for locale files (`conf/locale_xx-XX.ini` files), please read the [guide](https://gogs.io/docs/features/i18n), except for `conf/locale_en-US.ini` file.
2. Docker compose file. 2. Docker compose file.
3. 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. 3. 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 ### 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. 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.
### Coding guidelines ## Coding guidelines
1. Please follow the Sourcegraph's [Go style guide](https://about.sourcegraph.com/handbook/engineering/go_style_guide). 1. Please follow the Sourcegraph's [Go style guide](https://about.sourcegraph.com/handbook/engineering/go_style_guide).
2. All `.go` files must be formatted with `gofmt`. 2. All `.go` files must be formatted with `gofmt`.
3. All `.less` and `.tmpl` files must use **1 tab** as indention. 3. All `.less` and `.tmpl` files must use **1 tab** as indention.
4. **NO** direct modifications to `.css` files, `.css` files are all generated by `.less` files. Normally you can achieve this by executing `make less`. 4. **NO** direct modifications to `.css` files, `.css` files are all generated by `.less` files. Normally you can achieve this by executing `make less`.
### For UI changes ## For UI changes
1. Please use standard [Semantic UI](http://semantic-ui.com/) classes as much as possible to avoid editing `.less` files. 1. Please use standard [Semantic UI](http://semantic-ui.com/) classes as much as possible to avoid editing `.less` files.
2. Please attach corresponding screenshots for all representative pages that is affected by your changes. 2. Please attach corresponding screenshots for all representative pages that is affected by your changes.
3. If you need to add new locale strings, you **ONLY** need to care about `conf/locale_en-US.ini` file, **DO NOT** touch all the other locales files. 3. If you need to add new locale strings, you **ONLY** need to care about `conf/locale_en-US.ini` file, **DO NOT** touch all the other locales files.
### Final checks ## Final checks
1. There is **no guarantees** that your pull request will be merged. 1. There is **no guarantees** that your pull request will be merged.
2. Please expect code review being **VERY** strict, be prepared for benefiting future of this project. 2. Please expect code review being **VERY** strict, be prepared for benefiting future of this project.