Skip to content

docs(contributing): initial structure for revamped contributing guide #3133

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

Merged

Conversation

heitorlessa
Copy link
Contributor

@heitorlessa heitorlessa commented Sep 25, 2023

Issue number: #1916
Additional issue: #2181

Summary

This begins the initial structure for the newly revamped contributing guide. It keeps CONTRIBUTING.md intact until we have it in prod otherwise it can lead to 404 or stale content.

Changes

Please provide a summary of what's being changed

  • Add Contributing section in Processes
  • Add Development Environment
  • Add Your first contribution section
  • Create initial structure for final navigation (commented until we have docs)

Unrelated:

  • Update Event Handler roadmap
  • Update Sensitive Data Masking roadmap
  • Update Gov Cloud roadmap

User experience

Please share what the user experience looks like before and after this change

image

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

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.

@heitorlessa heitorlessa requested a review from a team September 25, 2023 09:24
@boring-cyborg boring-cyborg bot added documentation Improvements or additions to documentation internal Maintenance changes labels Sep 25, 2023
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 25, 2023
@heitorlessa
Copy link
Contributor Author

note: this is not a priority. It can be reviewed and merged when any maintainer has the bandwidth. Do not worry.

@leandrodamascena
Copy link
Contributor

note: this is not a priority. It can be reviewed and merged when any maintainer has the bandwidth. Do not worry.

Assigning this to me.

Hey @sthulb, can you check it out after I review it? It is nice a double-check.

Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@sonarqubecloud
Copy link

sonarqubecloud bot commented Oct 6, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.4% 0.4% Duplication

@heitorlessa heitorlessa merged commit 4b0140b into aws-powertools:develop Oct 6, 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 internal Maintenance changes size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: Meta-Documentation Docs: Add section on how to contribute tests to the overall project
2 participants