Debian Codegraph @

docs/internals/contributing/index.txt

raw
1 ======================
2 Contributing to Django
3 ======================
4
5 Django is a community that lives on its volunteers. As it keeps growing, we
6 always need more people to help others. You can contribute in many ways, either
7 on the framework itself or in the wider ecosystem.
8
9 Communication channels
10 ======================
11
12 We're passionate about helping Django users make the jump to contributing
13 members of the community. Communication is key - working on Django is being
14 part of a conversation. Join it, to become familiar with what we're doing and
15 how we talk about it. You'll be able to form relationships with more
16 experienced contributors who are there to help guide you towards success.
17
18 Join the Django community
19 -------------------------
20
21 There are several ways you can help the Django community and others to maintain
22 a great ecosystem to work in:
23
24 * Join the `Django Forum`_. This forum is a place for discussing the Django
25 framework and applications and projects that use it. This is also a good
26 place to ask and answer any questions related to installing, using, or
27 contributing to Django.
28
29 * Join the `Django Discord server`_ to discuss and answer questions. By
30 explaining Django to other users, you're going to learn a lot about the
31 framework yourself.
32
33 * Blog about Django. We syndicate all the Django blogs we know about on
34 the `community page`_; if you'd like to see your blog on that page you
35 can `register it here`_.
36
37 * Contribute to open-source Django projects, write some documentation, or
38 release your own code as an open-source pluggable application. The
39 ecosystem of pluggable applications is a big strength of Django, help us
40 build it!
41
42 .. _community page: https://www.djangoproject.com/community/
43 .. _Django Discord server: https://chat.djangoproject.com
44 .. _Django Forum: https://forum.djangoproject.com/
45 .. _register it here: https://www.djangoproject.com/community/add/blogs/
46
47 Getting started
48 ===============
49
50 Django encourages and welcomes new contributors, and makes an effort to help
51 them become experienced, confident contributors to Open Source Software (OSS).
52 Our documentation contains guidance for first-time contributors, including:
53
54 .. toctree::
55 :maxdepth: 1
56
57 An overview of the contributing process and what's involved. <new-contributors>
58
59 Work on the Django framework
60 ============================
61
62 If you enjoy working *with* Django, wait until you start working *on* it.
63 Really, **anyone** can do something to improve Django, which will improve the
64 experience of lots of people!
65
66 The work on Django itself falls into three major areas:
67
68 Contributing code
69 -----------------
70
71 Fix a bug, or add a new feature. You can make a pull request and see **your
72 code** in the next version of Django.
73
74 .. toctree::
75 :maxdepth: 2
76
77 writing-code/index
78
79 Contributing documentation
80 --------------------------
81
82 Django's documentation is one of its key strengths. It's informative and
83 thorough. You can help to improve the documentation and keep it relevant as the
84 framework evolves.
85
86 .. toctree::
87 :maxdepth: 2
88
89 writing-documentation
90
91 Localizing Django
92 -----------------
93
94 Django is translated into over 100 languages - There's even some translation
95 for Klingon?! The i18n team is always looking for translators to help maintain
96 and increase language reach.
97
98 .. toctree::
99 :maxdepth: 2
100
101 localizing
102
103 Other ways of contributing
104 ==========================
105
106 Explore additional avenues of contributing to Django beyond coding. Django's
107 `ticket tracker`_ is the central hub for managing issues, improvements, and
108 contributions to Django. It's a valuable resource where you can report bugs you
109 encounter or assist in triaging existing tickets to ensure a smooth development
110 workflow.
111
112 Django also has a :ref:`process for suggesting ideas <requesting-features>`
113 where you can join the community in discussing ideas for new features. Beyond
114 the Django codebase, there's a `vibrant ecosystem`_ that is maintained by the
115 community that you can contribute to.
116
117 Explore the ways you can make a difference below, and join us in making Django
118 better for everyone.
119
120 .. toctree::
121 :maxdepth: 2
122
123 bugs-and-features
124 triaging-tickets
125
126 .. _ticket tracker: https://code.djangoproject.com/
127 .. _vibrant ecosystem: https://www.djangoproject.com/community/ecosystem/
128
129 We're looking forward to working with you. Welcome aboard!