Skip to content

Maintenance: revamp contributing guidelines in docs #1746

Closed
@dreamorosi

Description

@dreamorosi

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.

Metadata

Metadata

Assignees

Labels

completedThis item is complete and has been merged/shippeddocumentationImprovements or additions to documentationinternalPRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)

Type

No type

Projects

Status

Shipped

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions