Contributing to OSCAR

We welcome contributions of many kinds to the OSCAR project — from improving the source code, to writing tutorials, to suggesting new entries for our curated publication list. No matter your background or level of technical experience, your contribution helps build a vibrant, open, and collaborative ecosystem around OSCAR.

Before starting, we recommend getting in touch with us to avoid duplicate efforts and discuss ideas. We are happy to help you find the best way to contribute.

Currently, most developments and additions are coordinated via GitHub. If you plan to contribute regularly, becoming familiar with GitHub will make collaboration smoother and faster. If you are new to GitHub, do not worry — you can always contact us directly, and we will guide you through the process.

Ways to Contribute

Report problems on GitHub.
Cite OSCAR if you used it in your research.
Improve tutorials to help others learn to use OSCAR.
Suggest new publications for our Bibliography.
Develop software projects that complement OSCAR — see Friends of OSCAR.
Contribute directly to the OSCAR codebase and documentation via Pull Requests on GitHub.

Contributing Publications

We maintain a curated list of notable OSCAR-related publications on the Bibliography page. To suggest an addition, edit _data/OSCAR-credits.yml and submit a Pull Request. Alternatively, get in touch via our Contact and Support page with the publication details.

Contributing Tutorials

We provide a list of tutorials that help others learn and use OSCAR effectively on the Tutorials page.

Tutorial authors are responsible for keeping their tutorials compatible with the latest stable OSCAR release. Tutorials that are no longer compatible will be marked as outdated.

To suggest a new tutorial:

Create a Jupyter notebook with the desired content.
Place this notebook in a GitHub repository of your choice.
Get in touch via our Contact and Support page and share the link to your Jupyter notebook with us.

If you need help, please get in touch with us.

Contributing Software Projects – Friends of OSCAR

The Friends of OSCAR initiative celebrates and connects software projects that complement, extend, or interoperate with OSCAR.

These Friends are independent projects that share our goals: advancing open-source computational mathematics, promoting interoperability, and supporting the research community.

Examples include experimental packages, research prototypes, and companion libraries developed by individual researchers or groups.

By joining Friends of OSCAR, your project will:

Be listed and promoted on the Friends of OSCAR GitHub page.
Gain visibility within the wider OSCAR ecosystem.
Facilitate collaboration and knowledge exchange with other developers and researchers.

How to become a Friend of OSCAR:

Visit Friends of OSCAR on GitHub.
Add your project following the contribution guidelines described there. A key part of this process is providing a small example showing how your project uses OSCAR.
Open a Pull Request to suggest your inclusion.
Optionally, contact us to discuss how your project integrates with OSCAR.

Whether you are a student exploring new ideas or a team maintaining a large research codebase, we warmly invite you to become a Friend of OSCAR. Your project can inspire others, expand OSCAR’s reach, and help build a stronger open-source mathematics community.

Contributing Source Code

Contributing directly to OSCAR’s codebase is a great way to strengthen the system itself.

You can fork the relevant GitHub repository from the list below and submit a Pull Request with your changes:

Oscar.jl – The main OSCAR repository
AbstractAlgebra.jl – Generic abstract algebra and abstract type definitions
AlgebraicSolving.jl – Algebraically solving multivariate polynomial systems
GAP.jl – GAP 4 to Julia bidirectional interface
Hecke.jl – Algebraic number theory
Nemo.jl – Wrappers of Flint/Arb/Antic C libraries
Polymake.jl – Polymake interface
Singular.jl – Singular interface

If you are unsure where your contribution fits best, please contact us — we are happy to help you find the right entry point.