aws-observability / observability-best-practices

Observability best practices on AWS
https://aws-observability.github.io/observability-best-practices/
MIT No Attribution
224 stars 69 forks source link

Process to report/fix typos #85

Open glenacota opened 1 year ago

glenacota commented 1 year ago

Is there a process to report and/or fix typos in the docs? For example:

  1. Do you prefer contributors to report typos or create PRs to fix them?
  2. In the case you accept PRs for fixing typos, do you prefer a separate PR for each doc page, or a single PR spanning multiple doc pages is also accepted?

BTW, thanks for this amazing piece of work.

lewinkedrs commented 1 year ago

Hey @glenacota , thanks for opening this issue. We will work on making an actual contributors guide to answer questions like this. But yes, we would love community contribution, so a PR that fixes any typos/issues you see is great. You can submit 1 PR that contains multiple doc pages.