From 5334f90f85fc7ba8b6e622f890e16844b7dca7cd Mon Sep 17 00:00:00 2001 From: blingblin-g Date: Thu, 27 Feb 2025 00:52:09 +0900 Subject: [PATCH 1/4] Add link to contributing documentation in CONTRIBUTING.md --- CONTRIBUTING.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 470c5ccdf..efc91ec2a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,11 @@ +# Contributing to Django Debug Toolbar + This is a [Django Commons](https://github.com/django-commons/) project. By contributing you agree to abide by the [Contributor Code of Conduct](https://github.com/django-commons/membership/blob/main/CODE_OF_CONDUCT.md). -Please see the -[README](https://github.com/django-commons/membership/blob/main/README.md) -for more help. +## Documentation + +For detailed contributing guidelines, please see our [Documentation](https://django-debug-toolbar.readthedocs.io/en/latest/contributing.html). + +## Additional Resources + +Please see the [README](https://github.com/django-commons/membership/blob/main/README.md) for more help. From 5e45ea3f4815468b2e3b9871b290c7fad06fc1f6 Mon Sep 17 00:00:00 2001 From: blingblin-g Date: Thu, 27 Feb 2025 00:59:13 +0900 Subject: [PATCH 2/4] Add change log --- docs/changes.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/changes.rst b/docs/changes.rst index 341f6e0b8..518246e3f 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -10,6 +10,7 @@ Pending * Wrap ``SHOW_TOOLBAR_CALLBACK`` function with ``sync_to_async`` or ``async_to_sync`` to allow sync/async compatibility. * Make ``require_toolbar`` decorator compatible to async views. +* Added link to contributing documentation in CONTRIBUTING.md to improve contributor onboarding. 5.0.1 (2025-01-13) ------------------ From f48a9d968912acfc29262251ce78cd293a4c9773 Mon Sep 17 00:00:00 2001 From: Luna <60090391+blingblin-g@users.noreply.github.com> Date: Thu, 27 Feb 2025 02:00:33 +0900 Subject: [PATCH 3/4] Update docs/changes.rst Co-authored-by: Matthias Kestenholz --- docs/changes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changes.rst b/docs/changes.rst index 518246e3f..509e2b117 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -10,7 +10,7 @@ Pending * Wrap ``SHOW_TOOLBAR_CALLBACK`` function with ``sync_to_async`` or ``async_to_sync`` to allow sync/async compatibility. * Make ``require_toolbar`` decorator compatible to async views. -* Added link to contributing documentation in CONTRIBUTING.md to improve contributor onboarding. +* Added link to contributing documentation in `CONTRIBUTING.md`. 5.0.1 (2025-01-13) ------------------ From 4bb31c5d91525dca55ac7692a6238436edd7d0b7 Mon Sep 17 00:00:00 2001 From: blingblin-g Date: Thu, 27 Feb 2025 02:05:38 +0900 Subject: [PATCH 4/4] Style pre-commit applied --- docs/changes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changes.rst b/docs/changes.rst index 509e2b117..f982350c4 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -10,7 +10,7 @@ Pending * Wrap ``SHOW_TOOLBAR_CALLBACK`` function with ``sync_to_async`` or ``async_to_sync`` to allow sync/async compatibility. * Make ``require_toolbar`` decorator compatible to async views. -* Added link to contributing documentation in `CONTRIBUTING.md`. +* Added link to contributing documentation in ``CONTRIBUTING.md``. 5.0.1 (2025-01-13) ------------------