You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,4 +2,6 @@
2
2
3
3
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.
4
4
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
+
5
7
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.
Copy file name to clipboardExpand all lines: docs/api-guide/throttling.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -110,7 +110,7 @@ You'll need to remember to also set your custom throttle class in the `'DEFAULT_
110
110
111
111
The built-in throttle implementations are open to [race conditions][race], so under high concurrency they may allow a few extra requests through.
112
112
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.
114
114
115
115
---
116
116
@@ -220,4 +220,5 @@ The following is an example of a rate throttle, that will randomly throttle 1 in
Copy file name to clipboardExpand all lines: docs/api-guide/validators.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Most of the time you're dealing with validation in REST framework you'll simply
13
13
14
14
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.
15
15
16
-
##Validation in REST framework
16
+
##Validation in REST framework
17
17
18
18
Validation in Django REST framework serializers is handled a little differently to how validation works in Django's `ModelForm` class.
19
19
@@ -75,7 +75,7 @@ This validator should be applied to *serializer fields*, like so:
Copy file name to clipboardExpand all lines: docs/community/contributing.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,8 @@
4
4
>
5
5
> —[Tim Berners-Lee][cite]
6
6
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
+
7
9
!!! note
8
10
9
11
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
28
30
29
31
# Issues
30
32
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
+
31
35
* 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.
32
37
* 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.
33
38
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
+
34
49
# Development
35
50
36
51
To start developing on Django REST framework, first create a Fork from the
0 commit comments