From 1938fe5d22801ca617ff8431ecfe083cdd8f3a62 Mon Sep 17 00:00:00 2001 From: Bruno Alla Date: Sun, 27 Apr 2025 14:00:03 +0100 Subject: [PATCH] Limit creation of new issues and clarify bug report process --- .github/ISSUE_TEMPLATE/config.yml | 11 +++++++++++ docs/community/contributing.md | 1 + 2 files changed, 12 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..011833fc1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Bug report + url: https://github.com/encode/django-rest-framework/compare + about: To report a bug, please open a pull request with a failing test reproducing the problem. + - name: New features + url: https://www.django-rest-framework.org/community/contributing/ + about: | + At this point in its lifespan, we consider Django REST framework to be feature-complete. + We focus on pull requests that track the continued development of Django versions, and + generally do not accept new features or code formatting changes. diff --git a/docs/community/contributing.md b/docs/community/contributing.md index 5a9188943..792955f69 100644 --- a/docs/community/contributing.md +++ b/docs/community/contributing.md @@ -30,6 +30,7 @@ The [Django code of conduct][code-of-conduct] gives a fuller set of guidelines f * Django REST framework is considered feature-complete. Please do not file requests to change behavior, unless it is required for security reasons or to maintain compatibility with upcoming Django or Python versions. * Feature requests will typically be closed with a recommendation that they be implemented outside the core REST framework library (e.g. as third-party libraries). This approach allows us to keep down the maintenance overhead of REST framework, so that the focus can be on continued stability and great documentation. +* To report a bug, open a pull request with a failing test. Apart from the above categories, we mainly focus on fixing regression bugs: things that used to work but recently stopped working. Anything else will be treated as a feature request. # Development