Skip to content

Commit b2ba0f7

Browse files
Add new ways to contribute, reformatting and add links
1 parent af0fb9d commit b2ba0f7

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

content/contributors/ways-to-contribute.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ All projects have a straightforward license that determines what you can and can
3232
The entire ecosystem relies on peer review and community production, so your contribution is really important.
3333
There are many ways to contribute outside of coding—we'll discuss a few.
3434

35-
### Issue testing and triaging
35+
### Issue testing, reproducing and triaging
3636

3737
Every Scientific Python project has its own issue tracker where users report bugs, suggest UX improvements, and discuss technical problems they are having.
3838
This lets developers support users and track improvement to the projects.
@@ -47,7 +47,7 @@ For example:
4747

4848
### Reviewing PRs
4949

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.
5151
You can help, even if you’re not familiar with them, by:
5252

5353
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
6161

6262
1. Many projects have tutorials which you can review and report confusing or missing parts.
6363
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.
6567
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.
6769

6870
### Translations
6971

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+
7174
If you speak a language other than English and feel comfortable translating, this is yet another way you can help.
7275

76+
You can also help by creating introductory tutorials and guides in native languages to support the local developers around you.
77+
7378
### Participating in the community
7479

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.
81+
82+
You can participate in the community by:
83+
84+
1. Joining discussion forums (Discourse, Discord, Gitter, Slack etc.)
85+
2. Joining community meetings and office hours
86+
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
7891

7992
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.
8093

0 commit comments

Comments
 (0)