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

Maintenance: revamp contributing guidelines in docs #1746

Closed
1 of 2 tasks
dreamorosi opened this issue Oct 16, 2023 · 1 comment · Fixed by #1747
Closed
1 of 2 tasks

Maintenance: revamp contributing guidelines in docs #1746

dreamorosi opened this issue Oct 16, 2023 · 1 comment · Fixed by #1747
Assignees
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)

Comments

@dreamorosi
Copy link
Contributor

Summary

The current contributing guidelines are overly verbose and somewhat hard to consume. The Python version of Powertools has adopted a new structure that moves the bulk of the information from the repo to the documentation which I think could benefit the project.

The CONTRIBUTING.md will still be present in the repo as it's surfaced to contributors opening issues or PR, but it will contain only the highlights of the process, and then link to the main docs for further information/context.

Why is this needed?

Revamping the contributing guidelines and adding them to the documentation website will give us more freedom to format and organize the information in a way that is easier to digest.

We hope that this change will make it easier for prospecting contributors to get involved.

Which area does this relate to?

Other

Solution

Adopt a similar structure.

Acknowledgment

Future readers

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

@dreamorosi dreamorosi added documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) confirmed The scope is clear, ready for implementation labels Oct 16, 2023
@dreamorosi dreamorosi self-assigned this Oct 16, 2023
@github-project-automation github-project-automation bot moved this from Working on it to Coming soon in Powertools for AWS Lambda (TypeScript) Oct 18, 2023
@github-actions
Copy link
Contributor

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues 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.

@dreamorosi dreamorosi moved this from Coming soon to Shipped in Powertools for AWS Lambda (TypeScript) Oct 18, 2023
@dreamorosi dreamorosi added completed This item is complete and has been merged/shipped and removed confirmed The scope is clear, ready for implementation labels Oct 18, 2023
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 documentation Improvements or additions to documentation 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.

1 participant