DevOp.Jira.Client is shaped around a simple public API, typed workflows, and readable Jira automation. Contributions should keep the package easy to discover, easy to test, and predictable for consumers.
| Path | Purpose |
|---|---|
src/DevOp.Jira.Client |
Main package source. |
src/DevOp.Jira.Client/Generated |
Generated Jira OpenAPI DTOs. Treat as generated code. |
src/DevOp.Jira.Client/Models |
Public domain models returned by the client. |
tests/DevOp.Jira.Client.Tests |
Unit, service, mapping, serialization, query, API, and integration tests. |
docs |
Repository documentation. |
samples/DevOp.Jira.Client.Sample |
Runnable sample showing common usage. |
Json suffix.customfield_XXXXX values through application code.A good implementation usually includes:
Tests are grouped by area so failures are easier to understand.
| Area | Focus |
|---|---|
| API | Public package contract checks. |
| Configuration | Options, dependency injection, and binding behavior. |
| Infrastructure | HTTP pipeline, request handling, and shared helpers. |
| Integration | Jira-backed tests for real Jira Cloud behavior. |
| Mapping | Domain model conversion and field mapping. |
| Query | Fluent query builder and JQL translation. |
| Serialization | JSON behavior and request payloads. |
| Services | Service method request and response behavior. |
Prefer structured JSON assertions over brittle substring checks.
Update documentation when a user would reasonably need to learn the feature, discover a new workflow, or understand a behavior change.
Good documentation should: