Default for source code header documentation

[joubertredrat]

Hi guys,

On my last PR #430 (comment) I add Gitea copyright on changed files, but I put copyright in year asc, as below:

// Copyright 2014 The Gogs Authors. All rights reserved.
// Copyright 2016 The Gitea Authors. All rights reserved.

On PR, @lunny asked to put in order desc, but for me is strange, because on PHP and Python projects is normal to put copyright in order year asc.

On Golang doesn't have a standard or definition for this yet, then I think that this is a chance to set default source code header and documentation for Gitea in general. With this it would even be possible to show for other projects for we make tools for API reference documentation in the future like PHPDoc, ApiGen, Doxygen, Sphinx, Javadoc and others.

Looking for principal Go projects on GitHub that I know, really doesn't exists a standard for this, as examples below:

• Minio: https://github.com/minio/minio/blob/master/main.go
• Caddy: https://github.com/mholt/caddy/blob/master/caddy.go
• Docker: https://github.com/docker/docker/blob/master/cli/cobra.go
• Kubernets: https://github.com/kubernetes/kubernetes/blob/master/cmd/kube-discovery/kubediscovery.go
• Beego: https://github.com/astaxie/beego/blob/master/beego.go
• Hugo: https://github.com/spf13/hugo/blob/master/main.go

Then, what my propose about this? Each one of us create one header documentation that like and discuss about this to create one standard.

What you think guys?

[tboerger]

// Copyright 2015 The Gogs Authors. All rights reserved.
// Copyright 2016 The Gitea Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http:https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

[lunny]

You mean order by year asc? @tboerger

[tboerger]

You mean order by year asc? @tboerger

Yes, that's how I also know that from other projects and languages.

[lunny]

OK. I will chek all the code and send a PR to fix this.

[lunny]

It seems all the files are correct. So let's close this issue.

[joubertredrat]

for now we solved problem about copyright ordenation.

But for future we can consider discuss about a possible new standard for we documentate all code?
@lunny @tboerger

[lunny]

Current it's enough, I think