From a90b25226a4dae41c439f4d4919ef07e21b2ad43 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Fri, 4 Nov 2016 09:39:04 +0800 Subject: [PATCH 1/4] added CONTRIBUTING --- CONTRIBUTING.md | 93 +++++++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTORS | 28 +++++++++++++++ MAINTAINERS | 28 +++++++++++++++ 3 files changed, 149 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 CONTRIBUTORS create mode 100644 MAINTAINERS diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..d454b6c478 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,93 @@ +# Contribution Guidelines + +## Introduction + +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 [security@gitea.io](mailto:security@gitea.io). + +## Discuss your design + +The project welcomes submissions but please let everyone know what +you're working on if you want to change or add to the Gitea repositories. + +Before undertaking 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. + +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. + +## Testing redux + +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 compitable when upgrade: + +After running for a while, the command should print + +``` +ALL TESTS PASSED +``` + +## Code review + +Changes to Gitea must be reviewed before they are accepted, +no matter who makes the change even if you are the owners or maintainers. +We use github's pull request workflow to do that and use lgtm to keep every PR has more than 2 maintainers to reviewed. + +## Contributers + +Everyone who sent a PR to gitea(or gogs) and accepted will be as a contributor. Please send a PR to add your name on +[CONTRIBUTORS](CONTRIBUTORS) and write PR numbers on the PR comment. For the format, see the [CONTRIBUTORS](CONTRIBUTORS). + +## Maintainers + +To keep every PR have been checked, we make a team maintainers. Any PR(include owners' PR) MUST be reviewed and by other two maintainers to check before merged. +Maintainers should be a contributor of gitea(or gogs) and contributed more than 4 PRs(included). And a contributar should apply as a maintainer in [gitter gitea develop](https://gitter.im/go-gitea/develop). +And the owners or the maintainers team maintainer could invite the contributor. A maintainer should spend some time on code view PRs. If some maintainer have no time +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. +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. + +## Owners + +Since gitea is a pure community organization with no any company support now, to keep it 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 someone owners don't obey this CONTRIBUTING, all the contributors could fork a new project and continue the project. + +After the election, the new owners should say he agree with the CONTRIBUTING on the [Gitter Gitea Channel](https://gitter.im/go-gitea/gitea). Below is the word to speak + +``` +I'm glad to be as 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. +``` + +For a honor to the owners, this document will add the history owners below: + +2016 - 2017 lunny tboerger bkcsoft + +## Versions + +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. +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. + +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, +All the PRs to all the branches should be review by two maintainers and pass the automatic tests. + +## Copyright + +Code that you contribute should use the standard copyright header: + +``` +// Copyright 2016 The Gitea Authors. All rights reserved. +// Use of this source code is governed by a MIT-style +// license that can be found in the LICENSE file. +``` + +Files in the repository are copyright the year they are added. It is not +necessary to update the copyright year on files that you change. diff --git a/CONTRIBUTORS b/CONTRIBUTORS new file mode 100644 index 0000000000..2cd463e8c4 --- /dev/null +++ b/CONTRIBUTORS @@ -0,0 +1,28 @@ +# This is the official list of people who can contribute +# (and typically have contributed) code to the Gitea repository. +# +# The submission process automatically checks to make sure +# that people submitting code are listed in this file (by email address). +# +# Names should be added to this file only after verifying that +# the individual or the individual's organization has agreed to +# the appropriate Contributor License Agreement, found here: +# +# http://code.google.com/legal/individual-cla-v1.0.html +# http://code.google.com/legal/corporate-cla-v1.0.html +# +# The agreement for individuals can be filled out on the web. +# + +# Names should be added to this file like so: +# Individual's name +# Individual's name +# +# An entry with multiple email addresses specifies that the +# first address should be used in the submit logs and +# that the other addresses should be recognized as the +# same person when interacting with github. + +# Please keep the list sorted. + +Lunny Xiao \ No newline at end of file diff --git a/MAINTAINERS b/MAINTAINERS new file mode 100644 index 0000000000..2cd463e8c4 --- /dev/null +++ b/MAINTAINERS @@ -0,0 +1,28 @@ +# This is the official list of people who can contribute +# (and typically have contributed) code to the Gitea repository. +# +# The submission process automatically checks to make sure +# that people submitting code are listed in this file (by email address). +# +# Names should be added to this file only after verifying that +# the individual or the individual's organization has agreed to +# the appropriate Contributor License Agreement, found here: +# +# http://code.google.com/legal/individual-cla-v1.0.html +# http://code.google.com/legal/corporate-cla-v1.0.html +# +# The agreement for individuals can be filled out on the web. +# + +# Names should be added to this file like so: +# Individual's name +# Individual's name +# +# An entry with multiple email addresses specifies that the +# first address should be used in the submit logs and +# that the other addresses should be recognized as the +# same person when interacting with github. + +# Please keep the list sorted. + +Lunny Xiao \ No newline at end of file From 0d41394d6e4ca48179c963faa4681baf5c059a19 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Fri, 4 Nov 2016 09:54:57 +0800 Subject: [PATCH 2/4] diff the CONTRIBUTORS and MAINTAINERS --- CONTRIBUTORS | 3 +-- MAINTAINERS | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTORS b/CONTRIBUTORS index 2cd463e8c4..5fa999c3a9 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -1,5 +1,4 @@ -# This is the official list of people who can contribute -# (and typically have contributed) code to the Gitea repository. +# This is the official list of people who have contributed code to the Gitea/Gogs repository. # # The submission process automatically checks to make sure # that people submitting code are listed in this file (by email address). diff --git a/MAINTAINERS b/MAINTAINERS index 2cd463e8c4..d39bcc53dc 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1,5 +1,4 @@ -# This is the official list of people who can contribute -# (and typically have contributed) code to the Gitea repository. +# This is the official list of people who have spent time on code review Pull Requests on the Gitea repository. # # The submission process automatically checks to make sure # that people submitting code are listed in this file (by email address). From 33df11e82312e8306885c34d5125fcca1ba3dd9b Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Fri, 4 Nov 2016 15:05:45 +0800 Subject: [PATCH 3/4] typo and contributing improved --- CONTRIBUTING.md | 38 +++++++++++++++++++------------------- CONTRIBUTORS | 10 ++-------- MAINTAINERS | 10 ++-------- 3 files changed, 23 insertions(+), 35 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d454b6c478..e05f0bb8d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,9 +11,9 @@ Sensitive security-related issues should be reported to [security@gitea.io](mail ## Discuss your design The project welcomes submissions but please let everyone know what -you're working on if you want to change or add to the Gitea repositories. +you're working on if you want to change or add something to the Gitea repositories. -Before undertaking to write something new for the Gitea project, +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) @@ -28,7 +28,7 @@ the code review tool is not the place for high-level discussions. ## Testing redux 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 compitable when upgrade: +tree to make sure the changes don't break other usage and keep the compatibility on upgrade: After running for a while, the command should print @@ -39,37 +39,37 @@ ALL TESTS PASSED ## Code review Changes to Gitea must be reviewed before they are accepted, -no matter who makes the change even if you are the owners or maintainers. -We use github's pull request workflow to do that and use lgtm to keep every PR has more than 2 maintainers to reviewed. +no matter who makes the change even if an owners or a maintainer. +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. -## Contributers +## Contributors -Everyone who sent a PR to gitea(or gogs) and accepted will be as a contributor. Please send a PR to add your name on -[CONTRIBUTORS](CONTRIBUTORS) and write PR numbers on the PR comment. For the format, see the [CONTRIBUTORS](CONTRIBUTORS). +Everyone who sent a PR to Gitea that gets accepted will be as a contributor. Please send a PR to add your name to +[CONTRIBUTORS](CONTRIBUTORS). For the format, see the [CONTRIBUTORS](CONTRIBUTORS). ## Maintainers -To keep every PR have been checked, we make a team maintainers. Any PR(include owners' PR) MUST be reviewed and by other two maintainers to check before merged. -Maintainers should be a contributor of gitea(or gogs) and contributed more than 4 PRs(included). And a contributar should apply as a maintainer in [gitter gitea develop](https://gitter.im/go-gitea/develop). -And the owners or the maintainers team maintainer could invite the contributor. A maintainer should spend some time on code view PRs. If some maintainer have no time +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. +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). +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 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. 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. ## Owners -Since gitea is a pure community organization with no any company support now, to keep it development healthly We will elect the owners every year. Every time we will elect three owners. +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 someone owners don't obey this CONTRIBUTING, all the contributors could fork a new project and continue the project. +If some owner don't obey these rules, the other owners are allowed to revoke his owner status. -After the election, the new owners should say he agree with the CONTRIBUTING on the [Gitter Gitea Channel](https://gitter.im/go-gitea/gitea). Below is the word to speak +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 ``` -I'm glad to be as 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. +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. ``` For a honor to the owners, this document will add the history owners below: -2016 - 2017 lunny tboerger bkcsoft +2016-11-04 ~ 2017-12-31 lunny tboerger bkcsoft ## Versions @@ -84,10 +84,10 @@ All the PRs to all the branches should be review by two maintainers and pass the Code that you contribute should use the standard copyright header: ``` -// Copyright 2016 The Gitea Authors. All rights reserved. +// Copyright 2016 - 2017 The Gitea Authors. All rights reserved. // Use of this source code is governed by a MIT-style // license that can be found in the LICENSE file. ``` -Files in the repository are copyright the year they are added. It is not -necessary to update the copyright year on files that you change. +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. diff --git a/CONTRIBUTORS b/CONTRIBUTORS index 5fa999c3a9..0dab1a4bda 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -1,15 +1,9 @@ # This is the official list of people who have contributed code to the Gitea/Gogs repository. +# This document should be reviewed and approved by maintainers. # # The submission process automatically checks to make sure # that people submitting code are listed in this file (by email address). # -# Names should be added to this file only after verifying that -# the individual or the individual's organization has agreed to -# the appropriate Contributor License Agreement, found here: -# -# http://code.google.com/legal/individual-cla-v1.0.html -# http://code.google.com/legal/corporate-cla-v1.0.html -# # The agreement for individuals can be filled out on the web. # @@ -22,6 +16,6 @@ # that the other addresses should be recognized as the # same person when interacting with github. -# Please keep the list sorted. +# Please keep the list sorted. Lunny Xiao \ No newline at end of file diff --git a/MAINTAINERS b/MAINTAINERS index d39bcc53dc..746656c290 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1,15 +1,9 @@ # This is the official list of people who have spent time on code review Pull Requests on the Gitea repository. +# This document should be reviewed and approved by owners. # # The submission process automatically checks to make sure # that people submitting code are listed in this file (by email address). # -# Names should be added to this file only after verifying that -# the individual or the individual's organization has agreed to -# the appropriate Contributor License Agreement, found here: -# -# http://code.google.com/legal/individual-cla-v1.0.html -# http://code.google.com/legal/corporate-cla-v1.0.html -# # The agreement for individuals can be filled out on the web. # @@ -22,6 +16,6 @@ # that the other addresses should be recognized as the # same person when interacting with github. -# Please keep the list sorted. +# Please keep the list sorted. Lunny Xiao \ No newline at end of file From 587d870f1edc51bf86bd0c213424d418702c9a24 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Fri, 4 Nov 2016 16:43:41 +0800 Subject: [PATCH 4/4] follow the advisor: add DCO and some improvements --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++-- DCO | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 72 insertions(+), 2 deletions(-) create mode 100644 DCO diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e05f0bb8d9..41522da117 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,13 +8,31 @@ It assumes you have followed the Sensitive security-related issues should be reported to [security@gitea.io](mailto:security@gitea.io). +## Bug reports + +Please search the issues on the issue tracker with a variety of keywords to +ensure your bug is not already reported. + +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. + +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). + +Please be kind, remember that Gitea comes at no cost to you, and you're +getting free help. + ## Discuss your design 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. Before starting to write something new for the Gitea project, -please [file an issue](https://github.com/go-gitea/gitea/issues/new). +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. @@ -42,6 +60,22 @@ Changes to Gitea must be reviewed before they are accepted, no matter who makes the change even if an owners or a maintainer. 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. +## Sign your work + +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: + +``` +Signed-off-by: Joe Smith +``` + +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`. + ## Contributors Everyone who sent a PR to Gitea that gets accepted will be as a contributor. Please send a PR to add your name to @@ -69,7 +103,7 @@ I'm glad to be an owner of Gitea, I agree with [CONTRIBUTING](CONTRIBUTING.md). For a honor to the owners, this document will add the history owners below: -2016-11-04 ~ 2017-12-31 lunny tboerger bkcsoft +2016-11-04 ~ 2017-12-31 lunny tboerger bkcsoft ## Versions diff --git a/DCO b/DCO new file mode 100644 index 0000000000..3aca339def --- /dev/null +++ b/DCO @@ -0,0 +1,36 @@ +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +660 York Street, Suite 102, +San Francisco, CA 94110 USA + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. \ No newline at end of file