Skip to content

Add new ways to contribute, reformatting and add links #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 26, 2023
Merged

Add new ways to contribute, reformatting and add links #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 21 additions & 8 deletions content/contributors/ways-to-contribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ All projects have a straightforward license that determines what you can and can
The entire ecosystem relies on peer review and community production, so your contribution is really important.
There are many ways to contribute outside of coding—we'll discuss a few.

### Issue testing and triaging
### Issue testing, reproducing and triaging

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

### Reviewing PRs

Pull requests (PRs) are the way in which Scientific Python projects incorporate new code.
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.
You can help, even if you’re not familiar with them, by:

1. Summarizing discussions in PRs so that newcomers to the conversation can easily catch up without reading the whole thread.
Expand All @@ -61,20 +61,33 @@ This doesn’t mean you need to write new documentation (which you can by follow

1. Many projects have tutorials which you can review and report confusing or missing parts.
2. Find typos and minor errors in docs and report them in the docs repository issue tracker.
3. If you feel like creating your own content, you can write your own guides and tutorials.
3. Add code examples for the documented functions.
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.
5. If you feel like creating your own content, you can write your own guides and tutorials.
There are several categories of materials you can produce: how-tos, deep-dive explanations, gallery examples, notebooks, videos, etc.
4. Apart from content, you can also improve docs organization and style.
6. Apart from content, you can also improve docs organization and style.

### Translations

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

If you speak a language other than English and feel comfortable translating, this is yet another way you can help.

You can also help by creating introductory tutorials and guides in native languages to support the local developers around you.

### Participating in the community

Every Scientific Python project has a community of volunteers that you can be part of.
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.
You can even help with community outreach by sharing content on Twitter, organizing code sprints, posting newsletter updates, or writing blogs.
Every Scientific Python project has a community of users, developers, maintainers, contributors, and volunteers that you can be part of.

You can participate in the community by:

1. Joining discussion forums (Discourse, Discord, Gitter, Slack etc.)
2. Joining community meetings and office hours
3. Social media outreach - Tweet/Mastodon/LinkedIn/Instagram
4. Writing blog posts
5. If you’re familiar with the project, help the newcomers by responding to the issues
6. Posting newsletter updates
7. Organising code sprints and hackathons

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.

Expand Down