Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Default for source code header documentation #438

Closed
joubertredrat opened this issue Dec 21, 2016 · 7 comments
Closed

Default for source code header documentation #438

joubertredrat opened this issue Dec 21, 2016 · 7 comments
Labels
type/docs This PR mainly updates/creates documentation
Milestone

Comments

@joubertredrat
Copy link
Contributor

joubertredrat commented Dec 21, 2016

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:

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
Copy link
Member

// 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://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
Copy link
Member

lunny commented Dec 21, 2016

You mean order by year asc? @tboerger

@tboerger
Copy link
Member

You mean order by year asc? @tboerger

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

@lunny
Copy link
Member

lunny commented Dec 21, 2016

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

@lunny
Copy link
Member

lunny commented Dec 21, 2016

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

@lunny lunny closed this as completed Dec 21, 2016
@lunny lunny added this to the 1.0.0 milestone Dec 21, 2016
@lunny lunny added the type/docs This PR mainly updates/creates documentation label Dec 21, 2016
@joubertredrat
Copy link
Contributor Author

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
Copy link
Member

lunny commented Dec 22, 2016

Current it's enough, I think

@go-gitea go-gitea locked and limited conversation to collaborators Nov 23, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type/docs This PR mainly updates/creates documentation
Projects
None yet
Development

No branches or pull requests

3 participants