Skip to content

Commit 64c3d9e

Browse files
authored
Restore references to GitHub Issues and Discussions (#9757)
* Revert "Removed reference to GitHub Issues and Discussions (#9660)" This reverts commit ffadde9. * Remove issue template * Update discussions description * Remove recommendations to open issues from the docs * Change a few non-breakable spaces to regular ones for better syntax highlighting in the editors
1 parent de018df commit 64c3d9e

File tree

6 files changed

+32
-5
lines changed

6 files changed

+32
-5
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discussions
4+
url: https://github.com/encode/django-rest-framework/discussions
5+
about: >
6+
The "Discussions" forum is where you want to start. 💖
7+
Please note that at this point in its lifespan, we consider Django REST framework to be feature-complete.

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22

33
At this point in its lifespan we consider Django REST framework to be essentially feature-complete. We may accept pull requests that track the continued development of Django versions, but would prefer not to accept new features or code formatting changes.
44

5+
Apart from minor documentation changes, the [GitHub discussions page](https://github.com/encode/django-rest-framework/discussions) should generally be your starting point. Please only open a pull request if you've been recommended to do so **after discussion**.
6+
57
The [Contributing guide in the documentation](https://www.django-rest-framework.org/community/contributing/) gives some more information on our process and code of conduct.

docs/api-guide/throttling.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ You'll need to remember to also set your custom throttle class in the `'DEFAULT_
110110

111111
The built-in throttle implementations are open to [race conditions][race], so under high concurrency they may allow a few extra requests through.
112112

113-
If your project relies on guaranteeing the number of requests during concurrent requests, you will need to implement your own throttle class.
113+
If your project relies on guaranteeing the number of requests during concurrent requests, you will need to implement your own throttle class. See [issue #5181][gh5181] for more details.
114114

115115
---
116116

@@ -220,4 +220,5 @@ The following is an example of a rate throttle, that will randomly throttle 1 in
220220
[identifying-clients]: http://oxpedia.org/wiki/index.php?title=AppSuite:Grizzly#Multiple_Proxies_in_front_of_the_cluster
221221
[cache-setting]: https://docs.djangoproject.com/en/stable/ref/settings/#caches
222222
[cache-docs]: https://docs.djangoproject.com/en/stable/topics/cache/#setting-up-the-cache
223+
[gh5181]: https://github.com/encode/django-rest-framework/issues/5181
223224
[race]: https://en.wikipedia.org/wiki/Race_condition#Data_race

docs/api-guide/validators.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Most of the time you're dealing with validation in REST framework you'll simply
1313

1414
However, sometimes you'll want to place your validation logic into reusable components, so that it can easily be reused throughout your codebase. This can be achieved by using validator functions and validator classes.
1515

16-
## Validation in REST framework
16+
## Validation in REST framework
1717

1818
Validation in Django REST framework serializers is handled a little differently to how validation works in Django's `ModelForm` class.
1919

@@ -75,7 +75,7 @@ This validator should be applied to *serializer fields*, like so:
7575
validators=[UniqueValidator(queryset=BlogPost.objects.all())]
7676
)
7777

78-
## UniqueTogetherValidator
78+
## UniqueTogetherValidator
7979

8080
This validator can be used to enforce `unique_together` constraints on model instances.
8181
It has two required arguments, and a single optional `messages` argument:
@@ -92,7 +92,7 @@ The validator should be applied to *serializer classes*, like so:
9292
# ...
9393
class Meta:
9494
# ToDo items belong to a parent list, and have an ordering defined
95-
# by the 'position' field. No two items in a given list may share
95+
# by the 'position' field. No two items in a given list may share
9696
# the same position.
9797
validators = [
9898
UniqueTogetherValidator(
@@ -166,7 +166,7 @@ If you want the date field to be entirely hidden from the user, then use `Hidden
166166

167167
---
168168

169-
**Note:** `HiddenField()` does not appear in `partial=True` serializer (when making `PATCH` request).
169+
**Note:** `HiddenField()` does not appear in `partial=True` serializer (when making `PATCH` request).
170170

171171
---
172172

docs/community/contributing.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
>
55
> — [Tim Berners-Lee][cite]
66
7+
There are many ways you can contribute to Django REST framework. We'd like it to be a community-led project, so please get involved and help shape the future of the project.
8+
79
!!! note
810

911
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.
@@ -28,9 +30,22 @@ The [Django code of conduct][code-of-conduct] gives a fuller set of guidelines f
2830

2931
# Issues
3032

33+
Our contribution process is that the [GitHub discussions page](https://github.com/encode/django-rest-framework/discussions) should generally be your starting point. Some tips on good potential issue reporting:
34+
3135
* 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.
36+
* Search the GitHub project page for related items, and make sure you're running the latest version of REST framework before reporting an issue.
3237
* 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.
3338

39+
## Triaging issues
40+
41+
Getting involved in triaging incoming issues is a good way to start contributing. Every single ticket that comes into the ticket tracker needs to be reviewed in order to determine what the next steps should be. Anyone can help out with this, you just need to be willing to
42+
43+
* Read through the ticket - does it make sense, is it missing any context that would help explain it better?
44+
* Is the ticket reported in the correct place, would it be better suited as a discussion on the discussion group?
45+
* If the ticket is a bug report, can you reproduce it? Are you able to write a failing test case that demonstrates the issue and that can be submitted as a pull request?
46+
* If the ticket is a feature request, could the feature request instead be implemented as a third party package?
47+
* If a ticket hasn't had much activity and addresses something you need, then comment on the ticket and try to find out what's needed to get it moving again.
48+
3449
# Development
3550

3651
To start developing on Django REST framework, first create a Fork from the

docs/community/project-management.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Further notes for maintainers:
3434
* Code changes should come in the form of a pull request - do not push directly to master.
3535
* Maintainers should typically not merge their own pull requests.
3636
* Each issue/pull request should have exactly one label once triaged.
37+
* Search for un-triaged issues with [is:open no:label][un-triaged].
3738

3839
---
3940

@@ -156,6 +157,7 @@ The following issues still need to be addressed:
156157
* Document ownership and management of the security mailing list.
157158

158159
[bus-factor]: https://en.wikipedia.org/wiki/Bus_factor
160+
[un-triaged]: https://github.com/encode/django-rest-framework/issues?q=is%3Aopen+no%3Alabel
159161
[transifex-project]: https://www.transifex.com/projects/p/django-rest-framework/
160162
[transifex-client]: https://pypi.org/project/transifex-client/
161163
[translation-memory]: http://docs.transifex.com/guides/tm#let-tm-automatically-populate-translations

0 commit comments

Comments
 (0)