Skip to content

expand contributors guideline on README #1510

@mohae

Description

@mohae

This is a result of talking with @strk on #go-nuts and the result of a pull request I saw that had no tests associated with it.

I think the contributors section should be expanded to include:

  • use gofmt
  • use govet
  • add test cases that show that the code does what it is supposed to do and handles failures properly, where appriopriate.

There may be additional things, like use golint, make sure errors are not ignored, etc.

I just wanted to start the ball rolling by opening this issue so that there can be additional discussion with the goal of reaching a consensus as to what the Contributors section should include.

Also, should there be more information to help people new to Go, Github, or contributing to Open Source to make it easier for them to get going with regards to contributing to gitea?

Once a consensus is reached, I'd be happy to make a pull request with changes that are consistent with what has been agreed to.

Regards,

Joel

Metadata

Metadata

Assignees

No one assigned

    Labels

    type/proposalThe new feature has not been accepted yet but needs to be discussed first.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions