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

Developer documentation improvements #608

Open
7 of 19 tasks
mattdot opened this issue Mar 1, 2025 · 0 comments · May be fixed by #609
Open
7 of 19 tasks

Developer documentation improvements #608

mattdot opened this issue Mar 1, 2025 · 0 comments · May be fixed by #609
Assignees
Labels
developer experience documentation Improvements or additions to documentation

Comments

@mattdot
Copy link
Member

mattdot commented Mar 1, 2025

As a new contributor to this repo I would like detailed developer documentation that includes the following so that I can confidently submit my first PR.

Getting Started

  • developer setup instructions
  • environment setup
  • makefile overview
  • quick start guide to compiling and running the provider
  • debugging

Contributor Documentation

  • Detailed instructions on how contributors can propose new features, bug fixes, or improvements. Should explain the PR process.
  • coding standards and style guidelines
  • testing guidelines - Requirements for writing tests, types of tests (unit and acceptance), and test coverage expectations
  • User documentation expectations - how to write and generate docs using tooling

Architecture

  • design philosophy of resources and data sources so that I understand how new resources and data sources should be designed
  • ADRs documenting key design decisions, including alternatives considered. Essential for historical context.

Build and Deployment

  • CI/CD pipelines documentation
  • Release process
  • Versioning

Engineering Fundamentals

  • Observability and logging
  • Security Guidelines and processes

Community and Support documentation

  • FAQ
  • Developer Support Channels
  • Documentation for interacting with maintainers
@mattdot mattdot added developer experience documentation Improvements or additions to documentation labels Mar 1, 2025
@mattdot mattdot self-assigned this Mar 1, 2025
@mattdot mattdot linked a pull request Mar 2, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer experience documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant