Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Bug report
about: Something in json-logging doesn't work as documented
labels: bug, needs triage
---

## What happened

## What you expected

## Minimal reproduction

<!-- The smallest app and config that shows the problem. -->

## Versions

- json-logging:
- Python:
- Framework and version (FastAPI, Flask, Quart, Sanic, Connexion):

<!-- Please wait for a maintainer to label this issue `ready` before opening a PR. -->
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/bobbui/json-logging-python/discussions
about: Usage questions are easier to answer in Discussions.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest a new capability or a change in behavior
labels: enhancement, needs triage
---

## The problem

<!-- What are you trying to do that's hard or impossible today? -->

## What you'd like

<!-- How would it work? Show the config or log output you'd expect. -->

## Alternatives you've tried

<!-- Please wait for a maintainer to label this issue `ready` before opening a PR. -->
14 changes: 14 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Fixes #

<!--
Every PR needs a linked issue labeled `ready` by a maintainer.
PRs without one may be closed without review. See CONTRIBUTING.md.
-->

## What changed and why

## How I tested it

- [ ] The linked issue is labeled `ready`
- [ ] Tests cover the change
- [ ] CHANGELOG.md has an entry under Unreleased, if users will notice the change
3 changes: 3 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,9 @@ possible. Use reasonable deadlines and always reap child processes.

## Pull requests and reviews

- Do not open a PR unless it links an issue a maintainer has labeled `ready`.
If the issue is missing or still `needs triage`, stop and leave it for triage.
See [CONTRIBUTING.md](CONTRIBUTING.md).
- Read the existing issue, relevant code, and current PR discussion before
proposing a fix; check for overlapping open PRs.
- Include a concise problem statement, root cause, focused patch, regression
Expand Down
37 changes: 37 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Contributing to json-logging

Thx for wanting to help. Please read this before you open a pull request.

## Issues come first

Every pull request needs a linked issue that a maintainer has triaged. An issue
is triaged once a maintainer has added the `ready` label to it. Until then it
carries the `needs triage` label.

The flow is:

1. Search open and closed issues for the same problem or idea.
2. Open a new issue from one of the templates, with a minimal reproduction for
bugs or a concrete use case for features.
3. Wait for a maintainer to triage it. They may ask questions, mark it as a
duplicate, decline it, or label it `ready`.
4. Once it's `ready`, comment that you're picking it up and open a PR that says
`Fixes #<issue>` in its description.

Pull requests without a linked `ready` issue may be closed without review, even
if the change looks fine. This keeps review time for changes the project has
agreed it wants, and it saves you from writing code that ends up declined.

A few changes don't need an issue: typo and broken link fixes, Dependabot
updates, and release PRs opened by maintainers.

## Before you open the PR

- Keep it to one bug or feature.
- Add tests for the behavior you changed.
- Add a changelog entry under `Unreleased` in `CHANGELOG.md` when users will
notice the change.
- Run the checks described in [MAINTENANCE.md](MAINTENANCE.md#development-and-ci).

If you use an AI coding agent, point it at [AGENTS.md](AGENTS.md). The same
triage rule applies.
8 changes: 7 additions & 1 deletion MAINTENANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ agents should follow [AGENTS.md](AGENTS.md).
published package when the distinction matters.
5. Link related issues and explain workarounds. Do not close unresolved
behavior without clear evidence or the appropriate project decision.
6. New issues from the templates start with `needs triage`. When an issue is
understood and the project wants a fix, swap `needs triage` for `ready`.
Only `ready` issues are open for pull requests.

For correlation ID defects, test synchronous and asynchronous handlers,
requests with and without a correlation header, and behavior across concurrent
Expand All @@ -23,7 +26,10 @@ running in a different thread.

## Pull-request review

- Keep changes small and reviewable, with a linked issue when useful.
- Every PR must link an issue labeled `ready`, except typo and link fixes,
Dependabot updates and maintainer release PRs. PRs without one may be closed
without review, pointing the author to [CONTRIBUTING.md](CONTRIBUTING.md).
- Keep changes small and reviewable.
- Include reproduction steps for fixes, targeted tests, and compatibility
notes. State what was *not* tested.
- Confirm no unintentional changes to log schema, correlation IDs, HTTP
Expand Down