--- tags: scipy, sprint --- # SciPy Sprints - SciPy **[Issues labelled `sprint`](https://github.com/scipy/scipy/issues?q=is%3Aopen+is%3Aissue+label%3Asprint) or [`good-first-issue`](https://github.com/scipy/scipy/issues?q=is%3Aopen+is%3Aissue+label%3Asprint) on the SciPy issue tracker** are a mix of code (mostly Python-level) and documentation issues selected for today's sprint. If you do not see a suitable issue or you are interested in a particular SciPy submodule, please look at the relevant submodule label or ask a mentor for a suggestion. ### Guides #### [SciPy Contributing documentation](https://scipy.github.io/devdocs/dev/contributor/contributor_toc.html) The following documentation will help you set up and build a local development environment: - [Fork and configuration of SciPy repository](https://scipy.github.io/devdocs/dev/gitwash/development_setup.html) - [Contributor quickstart guide](https://scipy.github.io/devdocs/dev/dev_quickstart.html) - [Complete build instructions](https://scipy.github.io/devdocs/dev/contributor/contributor_toc.html#development-environment) - As an aternative, use the SciPy GitHub codespaces setup _(this works without having to install anything, get to coding straight away in the browser!)_. Find more information in [the docs](https://docs.scipy.org/doc/scipy/dev/dev_quickstart.html#other-workflows) - General guidelines for contributing: - Read through the recommended [development workflow](https://scipy.github.io/devdocs/dev/contributor/development_workflow.html#development-workflow). - Read through how-to [guide to contributing to SciPy documentation](https://numpy.org/devdocs/dev/howto-docs.html) (same as NumPy). --- ## Get sprinting (aka fixing issues and submitting PRs)! * Please comment on the issue that you are working on to avoid multiple people taking on the same issue. We do not assign issues. * There are *a lot of* issues 😅! The selections labelled `sprint` and `good first issue` are focused on beginner-to-intermediate-friendly issues that are actionable and should be doable today. If you want to take on something a little more challenging, there are a lot of issues in the repo to choose from. If you search for an issue not labelled `sprint` or `good first issue`, try to choose issues that (from the title or labels) seem to be bugs, and don't have more than 5 comments - those are most likely to be actionable (old issues are often difficult to solve or unresolvable which is why they still remain.) #### Documentation issues If you are working on documentation, remember to check against https://scipy.github.io/devdocs/index.html. This is the version of the documentation corresponding to the latest development version (aka what is merged on the main branch on GitHub). #### How to co-author commits If you worked in a pair/group and would like to acknowledge multiple authors on the PR, find some helpful documentation [here.](https://gist.github.com/lisawolderiksen/f9747a3ae1e58e9daa7d176ab98f1bad) #### Labelling commit messages Commit messages should be clear and follow a few basic rules. Please try to label your commits with an indicative label. Here's the [SciPy guide](https://scipy.github.io/devdocs/dev/contributor/development_workflow.html#writing-the-commit-message). #### CI Skip commands TODO #### Recommended resources about contributing to open source - Talk *Sphinx for Python documentation* by Melissa Weber Mendonça: https://youtu.be/tXWscUSYdBs - Talk *Intro to git* by Reshama Shaikh: https://github.com/reshamas/git-intro-workshop - Guide to making open source contributions, for first-timers and veterans: https://opensource.guide/how-to-contribute/ - Guide to pair programming: https://medium.com/@weblab_tech/pair-programming-guide-a76ca43ff389 - Mentored Sprints community handbook: https://mentored-sprints.netlify.app/