Skip to content

Commit

Permalink
Merge pull request #767 from bressler1995/open-science-101
Browse files Browse the repository at this point in the history
Address Open Science 101 suggestion in issue #610
  • Loading branch information
bressler95tops authored Jun 25, 2024
2 parents 7a7bc83 + 9f6a8e8 commit 545cf72
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Module_4/Lesson_5/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ There are several types of contributing to open software. Not all of them requir
|---|---|
| **Add New Features** | The most obvious case for contributing to open software is enhancing its usability by adding new features. |
| **Fix Bugs** | Alternatively, you can reply to an already opened issue by fixing it. |
| **Report Issues and Make Suggestions About Improving Code** | Reporting an issue is a valuable contribution even if you dont know how to fix it. For example, you might be using a different browser in which the software has not been tested yet, have discovered a particularly uninformative error message, be colorblind or be otherwise able to feed a valuable user experience back to the developers that can help to improve the overall usability of the software. |
| **Report Issues and Make Suggestions About Improving Code** | Reporting an issue is a valuable contribution even if you don't know how to fix it. For example, you might be using a different browser in which the software has not been tested yet, have discovered a particularly uninformative error message, or be unable to feed a valuable user experience back to the developers that can help to improve the overall usability of the software. |
| **Improving and Contributing to Documentation** | Contributing to documentation constitutes a great starting point to contributing to open source software and is often overlooked in its importance. Writing documentations allows you to familiarize yourself with the use of the software, while helping to teach others. |
| **Create Tutorials, Use Cases, or Visuals** | Another way to contribute is to make your experience and use of the software publicly available. For example, you could create a tutorial based on your use of the software, summarize a use case or provide a summary of your use in a graphic. This part of contribution is particularly appealing as it does not create much extra work to just publish what you have used the software for. |
| **Improve Layout, Automatization, Structure of Code** | Apart from creating new code, a good way to contribute to open source software can also be to improve, restructure or automatize existing code. This is called refactoring and helps to make the software project more effective and stable. |
Expand Down

0 comments on commit 545cf72

Please sign in to comment.