Skip to content

Maintenance: revamp issue & PR templates #2411

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

Closed
1 of 2 tasks
dreamorosi opened this issue Apr 22, 2024 · 4 comments · Fixed by #2435
Closed
1 of 2 tasks

Maintenance: revamp issue & PR templates #2411

dreamorosi opened this issue Apr 22, 2024 · 4 comments · Fixed by #2435
Assignees
Labels
completed This item is complete and has been merged/shipped internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)

Comments

@dreamorosi
Copy link
Contributor

dreamorosi commented Apr 22, 2024

Summary

This issue captures two tasks that are somewhat related in that they impact how contributors and maintainers interact with the repository.

The current PR template has room for improvements. GitHub doesn't support forms for Pull Requests, so the editing experience is not great and the current template is overly verbose as evidenced by the fact that most of the time it doesn't get filled completely.

Finally, while the issue templates are in a good state, they could use some updates (see "Solution") section below.

Why is this needed?

So that the issue and PR creation is more streamlined, while keeping the same level of info for maintainers.

Which area does this relate to?

Governance

Solution

Proposed PR template:

## Summary

### Changes

> Please provide a summary of what's being changed

<!-- What is this PR solving? Write a clear description or reference the issue(s) it addresses. -->

> Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

**Issue number:** 

<!-------
Before creating the pull request, please make sure you do the following:

- Read the Contributing Guidelines at https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/CONTRIBUTING.md#sending-a-pull-request
- Check that there isn't already a PR that addresses the same issue. If you find a duplicate, please leave a comment under the existing PR so we can discuss how to move forward
- Check that the change meets the project's tenets https://docs.powertools.aws.dev/lambda/typescript/latest/#tenets
- Add a PR title that follows the conventional commit semantics - https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/.github/semantic.yml#L2
- If relevant, add tests that prove that the change is effective and works
- Whenever relevant, make sure to comment functions/methods/types and make appropriate changes to the documentation
------->

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

Regarding the issue templates, there's a number of changes that could be made. Some of these are:

  • update the dropdown areas to include all current utilities and ones on roadmap
  • check fields types so that they're rendered correctly, for example docs improvement uses a markdown type, while it should be a text

Acknowledgment

Future readers

Please react with 👍 and your use case to help us understand customer demand.

@dreamorosi dreamorosi added internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) discussing The issue needs to be discussed, elaborated, or refined labels Apr 22, 2024
@dreamorosi dreamorosi moved this from Triage to Backlog in Powertools for AWS Lambda (TypeScript) Apr 22, 2024
@dreamorosi dreamorosi self-assigned this Apr 22, 2024
@am29d
Copy link
Contributor

am29d commented Apr 22, 2024

I agree on the issue and PR templates. I am wondering if we should extend the PR template changes across all languages, to have the same experience.

@dreamorosi
Copy link
Contributor Author

I think we can bring it up to them, this has pretty much the same format as the Python repo except they have the issue number at the very top, and a couple of the bullet points are worded differently.

@dreamorosi dreamorosi moved this from Backlog to Working on it in Powertools for AWS Lambda (TypeScript) Apr 22, 2024
@dreamorosi dreamorosi added confirmed The scope is clear, ready for implementation and removed discussing The issue needs to be discussed, elaborated, or refined labels Apr 22, 2024
@dreamorosi dreamorosi moved this from Working on it to Pending review in Powertools for AWS Lambda (TypeScript) Apr 25, 2024
@github-project-automation github-project-automation bot moved this from Pending review to Coming soon in Powertools for AWS Lambda (TypeScript) Apr 25, 2024
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.

@github-actions github-actions bot added pending-release This item has been merged and will be released soon and removed confirmed The scope is clear, ready for implementation labels Apr 25, 2024
Copy link
Contributor

This is now released under v2.1.1 version!

@github-actions github-actions bot added completed This item is complete and has been merged/shipped and removed pending-release This item has been merged and will be released soon labels May 14, 2024
@dreamorosi dreamorosi moved this from Coming soon to Shipped in Powertools for AWS Lambda (TypeScript) May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed This item is complete and has been merged/shipped internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)
Projects
Development

Successfully merging a pull request may close this issue.

2 participants