-
Notifications
You must be signed in to change notification settings - Fork 47
Sdg23 add contribute page #446
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.
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
micaela-matta
merged 17 commits into
MDAnalysis:master
from
namiroues:sdg23-add-contribute-page-md
Mar 27, 2025
Merged
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
0688019
FIX broken links
namiroues 884c18e
add mamba instructions and refine installation quick start
namiroues 20d7e8f
Merge branch 'master' into sdg23-update-docs
namiroues 48bad02
add mamba instructions and refine installation quick start
namiroues aef7dbc
address PR review comments
namiroues 24583fb
Merge branch 'master' into sdg23-improve-website-navigation
namiroues 0dd030c
Add contribute page
namiroues 6f1ef2d
Merge remote-tracking branch 'origin/master' into sdg23-add-contribut…
namiroues 06d4f66
Revert unintended changes to installation_quick_start.md
namiroues 2e89f10
address PR review comments
namiroues e05ac73
add 'mentorship & outreach programs' to contribute page
namiroues 99786a3
address PR review comments
namiroues 7e1f993
address PR review comments
namiroues 18728ca
address PR review comments
namiroues 12dfbd3
address PR review comments
namiroues 7e792a9
address PR review comments
namiroues 2b34593
address PR review comments
namiroues File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| --- | ||
| layout: page | ||
| title: Contribute | ||
| order: 6 | ||
| --- | ||
|
|
||
| MDAnalysis is an open-source project that welcomes and encourages contributions from the community. Whether you're a developer, documentation writer, or interested in improving the website, there are many ways to get involved. | ||
|
|
||
| You can contribute by **developing new features, fixing bugs, improving documentation, enhancing tutorials, contributing to MDAKits, improving the website, or engaging in discussions**. | ||
|
|
||
| Contributions also extend to our **mentoring and outreach programs**, where participants gain hands-on experience in open-source development and scientific software. You can also contribute by **mentoring new contributors**, helping them navigate MDAnalysis, review their work, and share best practices. | ||
|
|
||
| If you're new, you can start by participating in community conversations and mentoring programs. For more information on how you can participate, check out the [Community]({{ site.baseurl }}/pages/community/) and [Events]({{ site.baseurl }}/pages/events/) pages. | ||
|
|
||
| The [MDAnalysis Project][] hosts several open-source repositories beyond the main library and MDAKits. You are welcome to contribute to any of them! Each repository typically has a `CONTRIBUTING.md` file to help you get started. If you’re unsure where to begin, you can: | ||
|
|
||
| - Check the repository’s issue tracker for open tasks. | ||
| - Submit a pull request for improvements. | ||
| - Contact maintainers via [GitHub discussions][] or MDAnalysis [Community]({{ site.baseurl }}/pages/community/) forums. | ||
|
|
||
| This page provides an overview of how you can contribute to the [Codebase](#contributing-to-the-codebase), [MDAKits](#contributing-to-mdakits), [Documentation](#contributing-to-the-documentation), or [Mentoring & Outreach Programs](#mentoring--outreach-programs). | ||
|
|
||
| ## Contributing to the Codebase | ||
| If you are interested in developing new features, fixing bugs, or improving performance, contributing to the MDAnalysis main codebase is a great way to get involved. | ||
|
|
||
| ### Main Codebase Repository | ||
| MDAnalysis is developed and maintained in the [MDAnalysis Main Code Repository]({{ site.github.repo }}), which contains: | ||
|
|
||
| - The core library for molecular dynamics analysis. | ||
| - The [API documentation]({{ site.docs.mdanalysis.url }}/stable/index.html), generated from in-code docstrings. | ||
| - [Open issues]({{ site.github.issues }}), where contributions such as bug fixes and feature implementations are tracked. | ||
|
|
||
| #### How to Get Started | ||
| - Read the [Contributing to the Main Codebase]({{ site.docs.userguide.url }}/stable/contributing_code.html#working-with-mdanalysis-code) guide, which outlines all the necessary steps. | ||
| - Browse [GitHub Issues]({{ site.github.issues }}) to find open tasks. Look for "good first issue" if you're a beginner. You can also report bugs or suggest improvements there. | ||
| - Follow best practices, including | ||
| - [Writing and Running Tests]({{ site.docs.userguide.url }}/stable/testing.html#testing) to ensure your changes work correctly. | ||
| - [Updating the Documentation]({{ site.docs.userguide.url }}/stable/contributing_code.html#building-code-documentation) when making modifications. | ||
|
|
||
| ## Contributing to MDAKits | ||
| [MDAKits]({{ site.mdakits.registry }}) are **community-driven projects** that extend MDAnalysis functionality. They allow researchers and developers to build tools tailored for specific workflows while staying within the MDAnalysis ecosystem. | ||
|
|
||
| ### MDAKits Registry | ||
| The [MDAKits Registry]({{ site.mdakits.registry }}) lists active projects contributed by the community. These projects cover various applications, such as enhanced trajectory analysis, molecular simulations, and integration with machine learning frameworks. | ||
|
|
||
| #### How to Get Started | ||
| - Find open issues in [MDAKits GitHub Issues]({{ site.mdakits.issues }}). | ||
namiroues marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Propose a new MDAKit by following the [MDAKits Guide]({{ site.mdakits.guide }}). | ||
| - Contribute to an existing MDAKit by collaborating with maintainers to improve functionality, fix bugs, or add new features. | ||
| - Explore existing MDAKits in the [MDAKits Registry]({{ site.mdakits.registry }}) to find projects that match your interests. Each entry includes functionality, installation instructions, and contribution guidelines. | ||
|
|
||
| MDAKits follow MDAnalysis coding standards but operate independently. Contributions to these projects are highly encouraged and help expand the MDAnalysis ecosystem. | ||
|
|
||
| ## Contributing to the Documentation | ||
| Good documentation is essential to making MDAnalysis accessible to users and developers. MDAnalysis maintains two types of documentation: the [User Guide]({{ site.docs.userguide.url }}) and the [API Reference]({{ site.docs.mdanalysis.url }}/stable/index.html). | ||
namiroues marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### User Guide | ||
| The [User Guide]({{ site.docs.userguide.url }}/stable/index.html) provides tutorials and explanatory content to help users install and learn MDAnalysis. You can contribute by updating unclear explanations, adding new tutorials or examples, or fixing outdated information. | ||
|
|
||
| #### How to Get Started | ||
| - Work on the [User Guide Repository]({{ site.docs.userguide.repo }}). | ||
| - Follow the [Contributing to the User Guide]({{ site.docs.userguide.url }}/stable/contributing_docs.html). | ||
| - Check for open documentation-related issues in the [User Guide GitHub Issues]({{ site.docs.userguide.issues }}). | ||
|
|
||
| ### API Reference | ||
| The [API reference]({{ site.docs.mdanalysis.url }}/stable/index.html) is **automatically generated** from *docstrings* in the codebase. It provides a structured reference for developers working with MDAnalysis. You can contribute by improving *docstrings* for functions, classes, and modules or updating outdated documentation. | ||
|
|
||
| #### How to Get Started | ||
| - Work on the [MDAnalysis Main Code Repository]({{ site.github.repo }}). | ||
| - Follow the [API Documentation Contribution Guide]({{ site.docs.userguide.url }}/stable/contributing_code.html#working-with-mdanalysis-docs). | ||
| - Browse open API documentation issues in [GitHub Issues]({{ site.github.issues }}). | ||
|
|
||
| ## Mentoring & Outreach Programs | ||
| MDAnalysis has actively participated in various mentoring and outreach programs **to help students, researchers, and early-career contributors gain experience in open-source development and scientific software**. Through these programs, participants receive mentorship, contribute to real-world projects, and develop valuable skills in computational science and software engineering. | ||
|
|
||
| ### Stay informed | ||
| For the latest announcements, deadlines, and project ideas, check out our [blog]({{ site.baseurl }}/blog/) where we share updates on participation and application guidelines. | ||
|
|
||
| We have been involved in several mentoring initiatives: | ||
|
|
||
| - **[Google Summer of Code (GSoC)](https://summerofcode.withgoogle.com/)** \ | ||
| A global, remote program where students contribute to open-source projects under mentorship, enhancing their programming skills while engaging with the open-source community. | ||
|
|
||
| - **[Google Season of Docs](https://developers.google.com/season-of-docs)** \ | ||
| A program that connects technical writers with open-source projects to improve documentation quality and accessibility. | ||
|
|
||
| - **[Outreachy](https://www.outreachy.org/)** \ | ||
| A diversity-focused program offering paid remote internships to individuals underrepresented in tech, providing opportunities to contribute to open-source software. | ||
|
|
||
| - **[Station1 Frontiers Fellowship](https://www.station1.org/sff)** \ | ||
| A unique research and internship program designed for students in science and technology, promoting inclusive and socially impactful research. | ||
|
|
||
| - **[CompChemURG](https://www.bindingsites.co.uk/home)** \ | ||
| A mentoring initiative focused on computational chemistry, supporting undergraduates and early-career researchers in gaining expertise in the field. | ||
|
|
||
| Many of our [core developers]({{ site.baseurl }}/governance/#mdanalysis-core-developers) started through these programs — consider joining and becoming part of the MDAnalysis community! | ||
|
|
||
| ### GSoC | ||
| MDAnalysis has participated in Google Summer of Code for several years, mentoring students on a variety of open-source projects. Explore our past projects: | ||
namiroues marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - [GSoC 2025]({% post_url 2025-02-28-gsoc2025 %}) | ||
| - [GSoC 2024]({% post_url 2024-02-27-gsoc2024 %}) | ||
| - [GSoC 2023]({% post_url 2023-02-22-gsoc2023 %}) | ||
| - [GSoC 2022]({% post_url 2022-03-07-gsoc2022 %}) | ||
| - [GSoC 2021]({% post_url 2021-03-09-gsoc2021 %}) | ||
| - [GSoC 2020]({% post_url 2020-02-22-gsoc2020 %}) | ||
| - [GSoC 2019]({% post_url 2019-03-04-gsoc2019 %}) | ||
| - [GSoC 2018]({% post_url 2018-02-14-gsoc2018 %}) | ||
| - [GSoC 2017]({% post_url 2017-03-02-gsoc2017 %}) | ||
| - [GSoC 2016]({% post_url 2016-04-26-gsoc %}) | ||
|
|
||
| ## Other Contributions | ||
| If you are interested in contributing in other ways, such as writing a **blog post**, we welcome contributions that document your experience with MDAnalysis — whether it's learning the software, participating in a UGM, or working on a project. Feel free to reach out via the [Community]({{ site.baseurl }}/pages/community/) page for guidance on submitting a post. | ||
|
|
||
| If you are interested in improving our website, you can refer to the [README file][] in the [Website Repository][]. While the website is already maintained by the MDAnalysis team, any fixes and updates are always welcome. | ||
|
|
||
| [MDAnalysis Project]: https://github.com/MDAnalysis/ | ||
| [GitHub discussions]: https://github.com/MDAnalysis/mdanalysis/discussions | ||
| [Website Repository]: https://github.com/MDAnalysis/MDAnalysis.github.io | ||
| [README file]: https://github.com/namiroues/MDAnalysis.github.io/blob/master/README.md | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.