Skip to content

Commit 9f437eb

Browse files
authored
Wrap text to 80 columns (#81)
Use a list for owners (nitpick response)
1 parent 92f39da commit 9f437eb

File tree

1 file changed

+90
-55
lines changed

1 file changed

+90
-55
lines changed

CONTRIBUTING.md

Lines changed: 90 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -2,51 +2,55 @@
22

33
## Introduction
44

5-
This document explains how to contribute changes to the Gitea project.
6-
It assumes you have followed the
7-
[installation instructions](https://github.com/go-gitea/docs/tree/master/en-US/installation)
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)
88

9-
Sensitive security-related issues should be reported to [[email protected]](mailto:[email protected]).
9+
Sensitive security-related issues should be reported to
10+
1011

1112
## Bug reports
1213

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

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

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

2628
Please be kind, remember that Gitea comes at no cost to you, and you're
2729
getting free help.
2830

2931
## Discuss your design
3032

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

34-
Before starting to write something new for the Gitea project,
35-
please [file an issue](https://github.com/go-gitea/gitea/issues/new).
36-
Significant changes must go through the
37-
[change proposal process](https://github.com/go-gitea/proposals)
38-
before they can be accepted.
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.
3942

40-
This process gives everyone a chance to validate the design,
41-
helps prevent duplication of effort,
42-
and ensures that the idea fits inside the goals for the project and tools.
43-
It also checks that the design is sound before code is written;
44-
the code review tool is not the place for high-level discussions.
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.
4548

4649
## Testing redux
4750

4851
Before sending code out for review, run all the tests for the whole
49-
tree to make sure the changes don't break other usage and keep the compatibility on upgrade:
52+
tree to make sure the changes don't break other usage and keep the
53+
compatibility on upgrade:
5054

5155
After running for a while, the command should print
5256

@@ -56,62 +60,92 @@ ALL TESTS PASSED
5660

5761
## Code review
5862

59-
Changes to Gitea must be reviewed before they are accepted,
60-
no matter who makes the change even if an owners or a maintainer.
61-
We use github's pull request workflow to do that and use [lgtm](http://lgtm.co) to ensure every PR is reviewed by at least 2 maintainers.
63+
Changes to Gitea must be reviewed before they are accepted, no matter
64+
who makes the change even if an owners or a maintainer. We use github's
65+
pull request workflow to do that and use [lgtm](http://lgtm.co) to ensure
66+
every PR is reviewed by at least 2 maintainers.
6267

6368
## Sign your work
6469

65-
The sign-off is a simple line at the end of the explanation for the patch. Your
66-
signature certifies that you wrote the patch or otherwise have the right to pass
67-
it on as an open-source patch. The rules are pretty simple: If you can certify
68-
[DCO](DCO), then you just add a line to every git commit message:
70+
The sign-off is a simple line at the end of the explanation for the
71+
patch. Your signature certifies that you wrote the patch or otherwise
72+
have the right to pass it on as an open-source patch. The rules are
73+
pretty simple: If you can certify [DCO](DCO), then you just add a line
74+
to every git commit message:
6975

7076
```
7177
Signed-off-by: Joe Smith <[email protected]>
7278
```
7379

7480
Please use your real name, we really dislike pseudonyms or anonymous
75-
contributions. We are in the opensource world without secrets. If you set your
76-
`user.name` and `user.email` git configs, you can sign your commit automatically
77-
with `git commit -s`.
81+
contributions. We are in the opensource world without secrets. If you
82+
set your `user.name` and `user.email` git configs, you can sign your
83+
commit automatically with `git commit -s`.
7884

7985
## Contributors
8086

81-
Everyone who sent a PR to Gitea that gets accepted will be as a contributor. Please send a PR to add your name to
82-
[CONTRIBUTORS](CONTRIBUTORS). For the format, see the [CONTRIBUTORS](CONTRIBUTORS).
87+
Everyone who sent a PR to Gitea that gets accepted will
88+
be as a contributor. Please send a PR to add your name to
89+
[CONTRIBUTORS](CONTRIBUTORS). For the format, see the
90+
[CONTRIBUTORS](CONTRIBUTORS).
8391

8492
## Maintainers
8593

86-
To make sure every PR have been checked, we make a team maintainers. Any PR MUST be reviewed and by at least two maintainers before it can get merged.
87-
Maintainers should be a contributor of gitea(or gogs) and contributed at least 4 accepted PRs. And a contributor should apply as a maintainer in [gitter Gitea develop](https://gitter.im/go-gitea/develop).
88-
And the owners or the team maintainer could invite the contributor. A maintainer should spend some time on code reviews. If some maintainer have no time
89-
to do that, he should apply to leave 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.
90-
If some one have no time to code view and forget to leave the maintainers, the owners have the power to move him from maintainers team to advisors team.
94+
To make sure every PR have been checked, we make a team maintainers. Any
95+
PR MUST be reviewed and by at least two maintainers before it can
96+
get merged. Maintainers should be a contributor of gitea(or gogs) and
97+
contributed at least 4 accepted PRs. And a contributor should apply as a
98+
maintainer in [gitter Gitea develop](https://gitter.im/go-gitea/develop).
99+
And the owners or the team maintainer could invite the contributor. A
100+
maintainer should spend some time on code reviews. If some maintainer
101+
have no time to do that, he should apply to leave maintainers team and
102+
we will give him an honor to be as a member of advisor team. Of course,
103+
if an advisor have time to code view, welcome it back to maintainers team.
104+
If some one have no time to code view and forget to leave the maintainers,
105+
the owners have the power to move him from maintainers team to advisors
106+
team.
91107

92108
## Owners
93109

94-
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.
95-
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.
96-
If some owner don't obey these rules, the other owners are allowed to revoke his owner status.
110+
Since Gitea is a pure community organization without any company
111+
support, to keep the development healthly We will elect the owners every
112+
year. Every time we will elect three owners. All the contributers could
113+
vote for three owners, one is the main owner, the other two are assistant
114+
owners. When the new owners have been elected, the old owners MUST move
115+
the power to the new owners. If some owner don't obey these rules,
116+
the other owners are allowed to revoke his owner status.
97117

98-
After the election, the new owners should say he agrees with these rules on the [CONTRIBUTING](CONTRIBUTING.md) on the [Gitter Gitea Channel](https://gitter.im/go-gitea/gitea). Below is the word to speak
118+
After the election, the new owners should say he agrees with these
119+
rules on the [CONTRIBUTING](CONTRIBUTING.md) on the [Gitter Gitea
120+
Channel](https://gitter.im/go-gitea/gitea). Below is the word to speak
99121

100122
```
101-
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.
123+
I'm glad to be an owner of Gitea,
124+
I agree with [CONTRIBUTING](CONTRIBUTING.md).
125+
I will spend part of my time on gitea
126+
and lead the development of gitea.
102127
```
103128

104-
For a honor to the owners, this document will add the history owners below:
129+
For a honor to the owners, this document will add the history owners
130+
below:
105131

106-
2016-11-04 ~ 2017-12-31 lunny <[email protected]> tboerger <[email protected]> bkcsoft <[email protected]>
132+
2016-11-04 ~ 2017-12-31
133+
134+
135+
- tboerger <[email protected]>
136+
- bkcsoft <[email protected]>
107137

108138
## Versions
109139

110-
Gitea has one master as a tip branch and have many version branch such as v0.9. v0.9 is a release branch and we will tag v0.9.0 both for binary download.
111-
If v0.9.0 have some bugs, we will accept PR on v0.9 and publish v0.9.1 and merge bug PR to master.
140+
Gitea has one master as a tip branch and have many version branch
141+
such as v0.9. v0.9 is a release branch and we will tag v0.9.0 both for
142+
binary download. If v0.9.0 have some bugs, we will accept PR on v0.9
143+
and publish v0.9.1 and merge bug PR to master.
112144

113-
Branch master is a tip version, so if you wish a production usage, please download the latest release tag version. All the branch will be protected via github,
114-
All the PRs to all the branches should be review by two maintainers and pass the automatic tests.
145+
Branch master is a tip version, so if you wish a production usage,
146+
please download the latest release tag version. All the branch will be
147+
protected via github, All the PRs to all the branches should be review
148+
by two maintainers and pass the automatic tests.
115149

116150
## Copyright
117151

@@ -123,5 +157,6 @@ Code that you contribute should use the standard copyright header:
123157
// license that can be found in the LICENSE file.
124158
```
125159

126-
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
127-
below the old one.
160+
Files in the repository are copyright the year they are added and the
161+
year they are last changed. If the copyright author is changed, just
162+
copy the head below the old one.

0 commit comments

Comments
 (0)