Skip to content

Default for source code header documentation #438

Closed
@joubertredrat

Description

@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:

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    type/docsThis PR mainly updates/creates documentation

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions