Skip to content

Commit

Permalink
Update 2003-01-01-bage-open-code.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GabrielPelletier authored Jul 25, 2024
1 parent 6ca3d2d commit a0a293e
Showing 1 changed file with 35 additions and 5 deletions.
40 changes: 35 additions & 5 deletions _posts/2003-01-01-bage-open-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,40 @@ orange {
</style>

### Description
Describe this badge
Implementing open code in scientific practices is crucial as it enables you to directly engage with computational methods, fostering hands-on learning experiences and skill development in programming and data analysis.
Additionally, open code promotes transparency and reproducibility in research. This means others can have a look at your code, reproduce your results more readily, understand how conclusions were drawn, and trust the science behind them. This process demystifies complex methodologies and promotes a learning environment where knowledge is open to everyone.
Moreover, open code encourages you to work together with others in the scientific community. It's about collaboration and innovation, providing you with opportunities to contribute to research projects and share your own discoveries effectively.

### Application Process
Describe the application application process and link to the application form etc..
### Requirements
To earn the Open Code badge, participants must fulfill criteria for at least one of the following options:

### Evaluation Criteria
List all the evaluation criteria ...
#### Option 1: Create and Share Open Source Code
1. Develop Open Source Code: Create open-source scripts, software, or package.
2. Publish on a Platform: Publish the code a platform like GitHub or GitLab. Ensure it is under an open-source license recognized by the Open Source Initiative.
3. Document Your Code: Include a README file at the root of the repository. Add docstrings and clear instructions for user-friendliness and reusability.
4. Provide Evidence: Provide a link to the published project. Write a summary highlighting the intended use and potential for reuse.

#### Option 2: Contribute Meaningfully to Existing Open Source Projects
1. Make Meaningful Contributions: Either multiple small contributions (e.g., multiple pull requests for small changes/additions) or one considerable contribution (e.g., a substantial pull request to fix a bug or add a feature). A contribution can be in the form of code, or adding documentation that improves the readability, reusability, and accessibility of existing code.
2. Ensure Accessibility: The code you are contributing tomust be on an accessible online platform (e.g., GitHub) and released under an open-source license recognized by the Open Source Initiative.
3. Provide Evidence: Provide links or screenshots of the contributions (e.g., documentation, merged pull requests). Provide links or screenshots of "Issues" engaged with on platforms like GitHub.

#### Option 3: Participate in Open Source Discussions
1. Engage in Community Forums or Issue Trackers: Participate actively in forums or issue trackers (e.g., Stack Overflow, GitHub, Stack Exchange, Neurostars, Biostars, image.sc). Review code on GitHub and partake in discussions to improve project quality.
2. Provide Evidence: Provide links or screenshots showcasing your involvement in these discussions.

### Submission Checklist:
Here is what to include in your submission form depending on which Option described above you are follow:

#### For Creating and Sharing Open Source Code (Option 1):
* Include link(s) to the published code.
* Include a summary of the project’s intended use and potential for reuse.

#### For Contributing to Existing Projects (Option 2):
* Include link(s) or screenshot(s) of merged pull requests.
* Include link(s) or screenshot(s) of issues you ahve engaged with.
* Include a simple summary of contributions.

#### For Participating in Discussions (Option 3):
* Include link(s) or screenshot(s) of involvement in community forums or issue trackers
* Include a simple summary of contributions.

0 comments on commit a0a293e

Please sign in to comment.