diff options
| -rw-r--r-- | CONTRIBUTING.md | 34 | ||||
| -rw-r--r-- | README.md | 3 |
2 files changed, 16 insertions, 21 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ea713ca455..d3619018a4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ > This guidelines sheet is forked from [CONTRIBUTING.md](https://github.com/drone/drone/blob/master/CONTRIBUTING.md). -Gogs is not perfect and it has bugs, or incomplete features for rare cases. You're welcome to tell us or contribute some code. This document describles details about how can you contribute to Gogs project. +Gogs is not perfect and it has bugs, or incomplete features for rare cases. You're welcome to tell us or contribute some code. This document describes details about how can you contribute to Gogs project. ## Contribution guidelines @@ -15,36 +15,30 @@ Depends on the situation, you will: ### Bug Report -If you find or consider something is a bug, please create a issue on [GitHub](https://github.com/gogits/gogs/issues). To reduce unnecessary time wasting of interacting and waiting with team members, please use following form as template in the first place: +If you find or consider something is a bug, please create a issue on [GitHub](https://github.com/gogits/gogs/issues). To reduce unnecessary time wasting of interacting and waiting with team members, please include following information in the first place with a comfortable form for you: -``` -- **Bug Description**: -- **Gogs Version**: -- **Git Version**: -- **System Type**: -- **Error Log**: -- **Other information**: -``` +- Bug Description +- Gogs Version +- Git Version +- System Type +- Error Log +- Other information Please take a moment to check that an issue on [GitHub](https://github.com/gogits/gogs/issues) doesn't already exist documenting your bug report or improvement proposal. If it does, it never hurts to add a quick "+1" or "I have this problem too". This will help prioritize the most common problems and requests. #### Bug Report Example -- **Bug Description**: Crash when create repository with license| -- **Gogs Version**: `v0.4.9.0901` -- **Git Version**: `1.9.0` -- **System Type**: `Ubuntu 12.04` -- **Error Log**: +Gogs crashed when create repository with license, using v0.5.13.0207, SQLite3, Git 1.9.0, Ubuntu 12.04. + +Error log: ``` 2014/09/01 07:21:49 [E] nil pointer ``` -- **Other information**: Use SQLite3 as database - ### Feature Request -There is no standard form of making a feature request, just try to describle the feature as clear as possible because team members may not have experience with the functionality you're talking about. +There is no standard form of making a feature request, just try to describe the feature as clear as possible because team members may not have experience with the functionality you're talking about. ### Pull Request @@ -54,7 +48,7 @@ We are always thrilled to receive pull requests, and do our best to process them If your pull request is not accepted on the first try, don't be discouraged! If there's a problem with the implementation, hopefully you received feedback on what to improve. -We're trying very hard to keep Gogs lean and focused. We don't want it to do everything for everybody. This means that we might decide against incorporating a new feature. +We're trying very hard to keep Gogs lean and focused. We don't want it to do everything for everybody. This means that we might decide against incorporating a new feature. We believe you do like to discuss with us first in [Gitter](https://gitter.im/gogits/gogs). ### Ask For Help @@ -77,4 +71,4 @@ Project maintainers have the right and responsibility to remove, edit, or reject Instances of abusive, harassing, or otherwise unacceptable behavior can be reported by emailing contact@gitlab.com -This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
\ No newline at end of file +This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/) @@ -13,6 +13,7 @@ Gogs(Go Git Service) is a painless self-hosted Git Service written in Go. - Due to testing purpose, data of [try.gogs.io](https://try.gogs.io) has been reset in **Jan 28, 2015** and will reset multiple times after. Please do **NOT** put your important data on the site. - Demo site [try.gogs.io](https://try.gogs.io) is running under `dev` branch. +- You **MUST** read [CONTRIBUTING.md](CONTRIBUTING.md) before you start filing a issue or making a Pull Request. - If you think there are vulnerabilities in the project, please talk private to **u@gogs.io**, thanks! #### Other language version @@ -81,7 +82,7 @@ There are 5 ways to install Gogs: ## Contributors -- The [core team](http://gogs.io/team) of this project. +- The [core team](http://gogs.io/team) of this project. - See [contributors page](https://github.com/gogits/gogs/graphs/contributors) for full list of contributors. - See [TRANSLATORS](conf/locale/TRANSLATORS) for full list of translators. |