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

Document goleak usage #1249

Conversation

LucasRoesler
Copy link
Member

Description

  • Expand the Contribution guide so to describe using goleak in unit
    tests. This package provides a simple method for detecting goroutine
    leaks in tests. This will help ensure that we write safe code.

Motivation and Context

  • I have raised an issue to propose this change (required)
  • My issue has received approval from the maintainers or lead with the design/approved label

Resolves #1248

How Has This Been Tested?

No tests are required beyond reading the Contribution.md file

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s
  • I have added tests to cover my changes.
  • All new and existing tests passed.

**What**
- Expand the Contribution guide so to describe using `goleak` in unit
tests.  This package provides a simple method for detecting goroutine
leaks in tests. This will help ensure that we write safe code.

Signed-off-by: Lucas Roesler <roesler.lucas@gmail.com>
@alexellis alexellis merged commit a259d12 into openfaas:master Jul 11, 2019
@alexellis
Copy link
Member

Thanks Lucas, good addition 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document goleak usage for contributors
2 participants