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

Docs: Add section on how to contribute tests to the overall project #1916

Closed
1 task done
sthulb opened this issue Feb 9, 2023 · 7 comments · Fixed by #3133
Closed
1 task done

Docs: Add section on how to contribute tests to the overall project #1916

sthulb opened this issue Feb 9, 2023 · 7 comments · Fixed by #3133
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@sthulb
Copy link
Contributor

sthulb commented Feb 9, 2023

What were you searching in the docs?

I was trying to find a section on how to setup a local test harness so I could write some tests

Is this related to an existing documentation section?

No response

How can we improve?

There needs to be a contributing/testing section in the docs to help people get up to speed faster with writing tests for the project.

Got a suggestion in mind?

No response

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.
@sthulb sthulb added documentation Improvements or additions to documentation triage Pending triage from maintainers labels Feb 9, 2023
@heitorlessa heitorlessa removed the triage Pending triage from maintainers label Mar 24, 2023
@sthulb sthulb moved this from Triage to Backlog in Powertools for AWS Lambda (Python) Jun 19, 2023
@leandrodamascena
Copy link
Contributor

Hi @sthulb! Are you talking about testing in general with Powertools? In our contributing guide we have a GitPod template ready to run the Powertools tests (local + e2e) and I wonder if that's not enough.

https://github.com/aws-powertools/powertools-lambda-python/blob/develop/CONTRIBUTING.md#contributing-via-pull-requests

Thank you.

@sthulb
Copy link
Contributor Author

sthulb commented Jun 21, 2023

@leandrodamascena I was thinking more like adding a section like: https://developer.hashicorp.com/terraform/plugin/testing/testing-patterns

@rubenfonseca
Copy link
Contributor

rubenfonseca commented Jun 29, 2023

While there may not be a dedicated "testing" section in the documentation, it's worth noting that each utility within the aws-powertools library typically includes a "Testing Your Code" section. (Example: batch processing). This section provides guidance on how to write tests specifically for that utility.

Expanding this with a dedicated section for testing will exponentially increase the effort to maintain the code. For now I will close the issue, and I ask you to reopen if necessary.

@github-actions
Copy link
Contributor

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

@leandrodamascena
Copy link
Contributor

@heitorlessa is working on this documentation.

Reopening.

@github-project-automation github-project-automation bot moved this from Shipped to Pending review in Powertools for AWS Lambda (Python) Sep 25, 2023
@github-project-automation github-project-automation bot moved this from Pending review to Coming soon in Powertools for AWS Lambda (Python) Oct 6, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Oct 6, 2023

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot added the pending-release Fix or implementation already in dev waiting to be released label Oct 6, 2023
@leandrodamascena leandrodamascena self-assigned this Oct 11, 2023
@github-actions
Copy link
Contributor

This is now released under 2.26.0 version!

@github-actions github-actions bot removed the pending-release Fix or implementation already in dev waiting to be released label Oct 13, 2023
@leandrodamascena leandrodamascena moved this from Coming soon to Shipped in Powertools for AWS Lambda (Python) Oct 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Shipped
4 participants