You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
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
Contributor Documentation
Architecture
Build and Deployment
Engineering Fundamentals
Community and Support documentation
The text was updated successfully, but these errors were encountered: