Skip to content

Commit 91d6c71

Browse files
author
Thomas Boerger
committed
Dropped new lines from contributing, some rewording and reformatting
1 parent caac5fb commit 91d6c71

File tree

1 file changed

+25
-131
lines changed

1 file changed

+25
-131
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 131 deletions
Original file line numberDiff line numberDiff line change
@@ -2,185 +2,79 @@
22

33
## Introduction
44

5-
This document explains how to contribute changes to the Gitea
6-
project. It assumes you have followed the [installation
7-
instructions](https://github.com/go-gitea/docs/tree/master/en-US/installation)
8-
9-
Sensitive security-related issues should be reported to
10-
5+
This document explains how to contribute changes to the Gitea project. It assumes you have followed the [installation instructions](https://github.com/go-gitea/docs/tree/master/en-US/installation). Sensitive security-related issues should be reported to [[email protected]](mailto:[email protected]).
116

127
## Bug reports
138

14-
Please search the issues on the issue tracker with a variety of keywords
15-
to ensure your bug is not already reported.
9+
Please search the issues on the issue tracker with a variety of keywords to ensure your bug is not already reported.
1610

17-
If unique, [open an issue](https://github.com/go-gitea/gitea/issues/new)
18-
and answer the questions so we can understand and reproduce the
19-
problematic behavior.
11+
If unique, [open an issue](https://github.com/go-gitea/gitea/issues/new) and answer the questions so we can understand and reproduce the problematic behavior.
2012

21-
The burden is on you to convince us that it is actually a bug
22-
in Gitea. This is easiest to do when you write clear, concise
23-
instructions so we can reproduce the behavior (even if it seems
24-
obvious). The more detailed and specific you are, the faster
25-
we will be able to help you. Check out [How to Report Bugs
26-
Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html).
13+
The burden is on you to convince us that it is actually a bug in Gitea. This is easiest to do when you write clear, concise instructions so we can reproduce the behavior (even if it seems obvious). The more detailed and specific you are, the faster we will be able to help you. Check out [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html).
2714

28-
Please be kind, remember that Gitea comes at no cost to you, and you're
29-
getting free help.
15+
Please be kind, remember that Gitea comes at no cost to you, and you're getting free help.
3016

3117
## Discuss your design
3218

33-
The project welcomes submissions but please let everyone know what
34-
you're working on if you want to change or add something to the Gitea
35-
repositories.
19+
The project welcomes submissions but please let everyone know what you're working on if you want to change or add something to the Gitea repositories.
3620

37-
Before starting to write something new for the Gitea project, please
38-
[file an issue](https://github.com/go-gitea/gitea/issues/new).
39-
Significant changes must go through the [change proposal
40-
process](https://github.com/go-gitea/proposals) before they can be
41-
accepted.
21+
Before starting to write something new for the Gitea project, please [file an issue](https://github.com/go-gitea/gitea/issues/new). Significant changes must go through the [change proposal process](https://github.com/go-gitea/proposals) before they can be accepted.
4222

43-
This process gives everyone a chance to validate the design, helps
44-
prevent duplication of effort, and ensures that the idea fits inside
45-
the goals for the project and tools. It also checks that the design is
46-
sound before code is written; the code review tool is not the place for
47-
high-level discussions.
23+
This process gives everyone a chance to validate the design, helps prevent duplication of effort, and ensures that the idea fits inside the goals for the project and tools. It also checks that the design is sound before code is written; the code review tool is not the place for high-level discussions.
4824

4925
## Testing redux
5026

51-
Before sending code out for review, run all the tests for the whole
52-
tree to make sure the changes don't break other usage and keep the
53-
compatibility on upgrade:
54-
55-
After running for a while, the command should print
56-
57-
```
58-
ALL TESTS PASSED
59-
```
60-
## Vendoring
61-
62-
We keep a cached copy of dependencies within the `vendor/` directory,
63-
managing updates via [govendor](http://github.com/kardianos/govendor).
64-
65-
Pull requests should only include `vendor/` updates if they are
66-
part of the same change, be it a bugfix or a feature addition.
67-
68-
The `vendor/` update needs to be justified as part of the PR description,
69-
and must be verified by the reviewers and/or merger to always reference
70-
an existing upstream commit.
27+
Before sending code out for review, run all the tests for the whole tree to make sure the changes don't break other usage and keep the compatibility on upgrade. To make sure you are running the test suite exactly like we do you should install the CLI for [Drone CI](https://github.com/drone/drone) as we are using the server for continous testing, follow [these instructions](http://readme.drone.io/0.5/install/cli/). After that you can simply call `drone exec` within you working directory and it will try to run the test suite locally.
7128

7229
## Code review
7330

74-
Changes to Gitea must be reviewed before they are accepted, no matter
75-
who makes the change even if an owners or a maintainer. We use github's
76-
pull request workflow to do that and use [lgtm](http://lgtm.co) to ensure
77-
every PR is reviewed by at least 2 maintainers.
78-
79-
Please try to make your pull request easy to review for us. Please read the
80-
["How to get faster PR reviews"](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/faster_reviews.md),
81-
guide, it got useful tips for any project you may want to contribute. See some
82-
of the points:
83-
84-
- Make small pull requests. The smaller, the faster to review and the more
85-
likely it will be merged soon.
86-
- Don't make changes unrelated to your PR. Maybe there are typos on some
87-
comments, maybe refactoring would welcome on a function... but if that is not
88-
related to you PR, please make *another* PR for that.
89-
- Split big pull requests in multiple. An incremental change will be faster to
90-
review than a huge PR.
31+
Changes to Gitea must be reviewed before they are accepted, no matter who makes the change even if an owner or a maintainer. We use GitHub's pull request workflow to do that and we also use [LGTM](http://lgtm.co) to ensure every PR is reviewed by at least 2 maintainers.
9132

9233
## Sign your work
9334

94-
The sign-off is a simple line at the end of the explanation for the
95-
patch. Your signature certifies that you wrote the patch or otherwise
96-
have the right to pass it on as an open-source patch. The rules are
97-
pretty simple: If you can certify [DCO](DCO), then you just add a line
98-
to every git commit message:
35+
The sign-off is a simple line at the end of the explanation for the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: If you can certify [DCO](DCO), then you just add a line to every git commit message:
9936

10037
```
10138
Signed-off-by: Joe Smith <[email protected]>
10239
```
10340

104-
Please use your real name, we really dislike pseudonyms or anonymous
105-
contributions. We are in the opensource world without secrets. If you
106-
set your `user.name` and `user.email` git configs, you can sign your
107-
commit automatically with `git commit -s`.
108-
109-
## Contributors
110-
111-
Everyone who sent a PR to Gitea that gets accepted will
112-
be as a contributor. Please send a PR to add your name to
113-
[CONTRIBUTORS](CONTRIBUTORS). For the format, see the
114-
[CONTRIBUTORS](CONTRIBUTORS).
41+
Please use your real name, we really dislike pseudonyms or anonymous contributions. We are in the opensource world without secrets. If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with `git commit -s`.
11542

11643
## Maintainers
11744

118-
To make sure every PR have been checked, we make a team maintainers. Any
119-
PR MUST be reviewed and by at least two maintainers before it can
120-
get merged. Maintainers should be a contributor of gitea(or gogs) and
121-
contributed at least 4 accepted PRs. And a contributor should apply as a
122-
maintainer in [gitter Gitea develop](https://gitter.im/go-gitea/develop).
123-
And the owners or the team maintainer could invite the contributor. A
124-
maintainer should spend some time on code reviews. If some maintainer
125-
have no time to do that, he should apply to leave maintainers team and
126-
we will give him an honor to be as a member of advisor team. Of course,
127-
if an advisor have time to code view, welcome it back to maintainers team.
128-
If some one have no time to code view and forget to leave the maintainers,
129-
the owners have the power to move him from maintainers team to advisors
130-
team.
45+
To make sure every PR have been checked, we got team maintainers. Any PR MUST be reviewed and by at least two maintainers before it can get merged. Maintainers should be a contributor of Gitea (or Gogs) and contributed at least 4 accepted PRs. A contributor should apply as a maintainer in [Gitter development channel](https://gitter.im/go-gitea/develop). The owners or the team maintainers could invite the contributor. A maintainer should spend some time on code reviews. If some maintainer have no time to do that, he should apply to leave the maintainers team and we will give him an honor to be as a member of advisor team. Of course, if an advisor have time to code view, welcome it back to maintainers team. If someone have no time to code review and forget to leave the maintainers team, the owners have the power to move him from maintainers team to advisors team.
13146

13247
## Owners
13348

134-
Since Gitea is a pure community organization without any company
135-
support, to keep the development healthly We will elect the owners every
136-
year. Every time we will elect three owners. All the contributers could
137-
vote for three owners, one is the main owner, the other two are assistant
138-
owners. When the new owners have been elected, the old owners MUST move
139-
the power to the new owners. If some owner don't obey these rules,
140-
the other owners are allowed to revoke his owner status.
49+
Since Gitea is a pure community organization without any company support, to keep the development healthly we will elect the owners every year. Every time we will elect three owners. All the contributers could vote for three owners, one is the main owner, the other two are assistant owners. When the new owners have been elected, the old owners MUST move the power to the new owners. If some owner don't obey these rules, the other owners are allowed to revoke his owner status.
14150

142-
After the election, the new owners should say he agrees with these
143-
rules on the [CONTRIBUTING](CONTRIBUTING.md) on the [Gitter Gitea
144-
Channel](https://gitter.im/go-gitea/gitea). Below is the word to speak
51+
After the election, the new owners should say he agrees with these rules on the [CONTRIBUTING](CONTRIBUTING.md) on the [Gitter main channel](https://gitter.im/go-gitea/gitea). Below are the words to speak:
14552

14653
```
147-
I'm glad to be an owner of Gitea,
148-
I agree with [CONTRIBUTING](CONTRIBUTING.md).
149-
I will spend part of my time on gitea
150-
and lead the development of gitea.
54+
I'm glad to be an owner of Gitea, I agree with [CONTRIBUTING](CONTRIBUTING.md). I will spend part of my time on Gitea and lead the development of Gitea.
15155
```
15256

153-
For a honor to the owners, this document will add the history owners
154-
below:
155-
156-
2016-11-04 ~ 2017-12-31
57+
For a honor to the owners, this document will add the history owners below:
15758

158-
159-
- tboerger <[email protected]>
160-
- bkcsoft <[email protected]>
59+
* 2016-11-04 ~ 2017-12-31
60+
* [Lunny Xiao](https://github.com/lunny) <[email protected]>
61+
* [Thomas Boerger](https://github.com/tboerger) <[email protected]>
62+
* [Kim Carlbäcker](https://github.com/bkcsoft) <[email protected]>
16163

16264
## Versions
16365

164-
Gitea has one master as a tip branch and have many version branch
165-
such as v0.9. v0.9 is a release branch and we will tag v0.9.0 both for
166-
binary download. If v0.9.0 have some bugs, we will accept PR on v0.9
167-
and publish v0.9.1 and merge bug PR to master.
66+
Gitea has one master as a tip branch and have version branches such as `v0.9`. `v0.9` is a release branch and we will tag `v0.9.0` for binary download. If `v0.9.0` got some bug, we will accept pull requests on the `v0.9` branch and publish a `v0.9.1` tag, afterwards we will port the bug fix also to the master branch.
16867

169-
Branch master is a tip version, so if you wish a production usage,
170-
please download the latest release tag version. All the branch will be
171-
protected via github, All the PRs to all the branches should be review
172-
by two maintainers and pass the automatic tests.
68+
The `master` branch is a tip version, so if you wish a production usage, please download the latest release tag version. All the branches will be protected via github, all the PRs to all the branches should be review by two maintainers and pass the automatic tests.
17369

17470
## Copyright
17571

17672
Code that you contribute should use the standard copyright header:
17773

17874
```
179-
// Copyright 2016 - 2017 The Gitea Authors. All rights reserved.
75+
// Copyright 2016 The Gitea Authors. All rights reserved.
18076
// Use of this source code is governed by a MIT-style
18177
// license that can be found in the LICENSE file.
18278
```
18379

184-
Files in the repository are copyright the year they are added and the
185-
year they are last changed. If the copyright author is changed, just
186-
copy the head below the old one.
80+
Files in the repository are copyright the year they are added and the year they are last changed. If the copyright author is changed, just copy the head below the old one.

0 commit comments

Comments
 (0)