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
Copy file name to clipboardExpand all lines: content/contributors/ways-to-contribute.md
+21-8Lines changed: 21 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ All projects have a straightforward license that determines what you can and can
32
32
The entire ecosystem relies on peer review and community production, so your contribution is really important.
33
33
There are many ways to contribute outside of coding—we'll discuss a few.
34
34
35
-
### Issue testing and triaging
35
+
### Issue testing, reproducing and triaging
36
36
37
37
Every Scientific Python project has its own issue tracker where users report bugs, suggest UX improvements, and discuss technical problems they are having.
38
38
This lets developers support users and track improvement to the projects.
@@ -47,7 +47,7 @@ For example:
47
47
48
48
### Reviewing PRs
49
49
50
-
Pull requests (PRs) are the way in which Scientific Python projects incorporate new code.
50
+
Pull requests ([PRs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)) are the way in which Scientific Python projects incorporate new code.
51
51
You can help, even if you’re not familiar with them, by:
52
52
53
53
1. Summarizing discussions in PRs so that newcomers to the conversation can easily catch up without reading the whole thread.
@@ -61,20 +61,33 @@ This doesn’t mean you need to write new documentation (which you can by follow
61
61
62
62
1. Many projects have tutorials which you can review and report confusing or missing parts.
63
63
2. Find typos and minor errors in docs and report them in the docs repository issue tracker.
64
-
3. If you feel like creating your own content, you can write your own guides and tutorials.
64
+
3. Add code examples for the documented functions.
65
+
4. To ensure functionality, test the pre-existing code samples provided in the documentation. Keep in mind that occasional version upgrades may cause the code samples to malfunction.
66
+
5. If you feel like creating your own content, you can write your own guides and tutorials.
65
67
There are several categories of materials you can produce: how-tos, deep-dive explanations, gallery examples, notebooks, videos, etc.
66
-
4. Apart from content, you can also improve docs organization and style.
68
+
6. Apart from content, you can also improve docs organization and style.
67
69
68
70
### Translations
69
71
70
-
Most Scientific Python projects are developed in English, but an increasing number use online platforms such as Crowdin to translate their interface, webpage, and documentation.
72
+
Most Scientific Python projects are developed in English, but an increasing number use online platforms such as [Crowdin](https://crowdin.com/) to translate their interface, webpage, and documentation.
73
+
71
74
If you speak a language other than English and feel comfortable translating, this is yet another way you can help.
72
75
76
+
You can also help by creating introductory tutorials and guides in native languages to support the local developers around you.
77
+
73
78
### Participating in the community
74
79
75
-
Every Scientific Python project has a community of volunteers that you can be part of.
76
-
You can get involved in online conversations and discussions about the projects, offer help to newcomers, come to community meetings, or teach others about the project.
77
-
You can even help with community outreach by sharing content on Twitter, organizing code sprints, posting newsletter updates, or writing blogs.
80
+
Every Scientific Python project has a community of users, developers, maintainers, contributors, and volunteers that you can be part of.
3. Social media outreach - Tweet/Mastodon/LinkedIn/Instagram
87
+
4. Writing blog posts
88
+
5. If you’re familiar with the project, help the newcomers by responding to the issues
89
+
6. Posting newsletter updates
90
+
7. Organising code sprints and hackathons
78
91
79
92
As you've seen, there are many ways to contribute to Scientific Python! No matter what you have to offer, go ahead reach out to project maintainers: they will be happy to receive all the help they can get.
0 commit comments