- Sprint GitHub repo: WiMLDS/berlin-2021-numpy-sprint/
- NumPy GitHub repo: NumPy/numpy
- Join Mentored Sprints server on Discord (invitation-only) Helpful but not essential:
- Join WiMLDS Slack group
- Join NumPy Slack group
- Slides from opening zoom presentation
7pm-9pm (CET) Technical preperation of your computers with support from NumPy Mentors. This is a requirement, we want all participants to be fully set up before we begin the actual sprint.
The slides from the pre-sprint event.
- Kick-off via zoom link at 3pm(CEST) 9th May
- Guide to selecting Issues
- Quick refresh on Discord environment (Roles/Groups/Tables etc)
- Get sprinting (via Discord)
Please fill out our Post-sprint feedback survey:
For continued support and following up on your pull requests:
- Reach out to NumPy on their mailing-list or GitHub.
- Open an issue or comment on an issue.
- NumPy also invites participants to join their bi-weekly community meetings, Slack channel and "newcomer's hour". Email them for an invitation here: [email protected]
- If you haven't already, we also recommend you join our WiMLDS Slack group. Email us here: [email protected] and we'll send you an invite, then be sure to join our #meetup-berlin channel for local news and updates
WiMLDS is dedicated to providing a harassment-free experience for everyone. We do not tolerate harassment of participants in any form. All communication should be appropriate for a professional audience including people of many different backgrounds. Sexual language and imagery is not appropriate.
Be kind to others. Do not insult or put down others. Behave professionally. Remember that harassment and sexist, racist, or exclusionary jokes are not appropriate.
Thank you for helping make this a welcoming, friendly community for all. Please read the full Code of Conduct before participating.
CoC summary is adopted from NumFOCUS.
- Emily Taylor (Berlin WiMLDS Organizer) ([email protected])
- Noa Tamir @noatamir (Berlin WiMLDS Organizer) ([email protected])
- Marielle Dado (Berlin WiMLDS Organizer) ([email protected])
- Sunayana Ghosh (Berlin WiMLDS Organizer) ([email protected])
NumPy is a library that is used around the world. Open source sprints are typically limited to where contributors live or where major conferences are held. We are fortunate to have support from several Numpy contributors:
- Melissa Mendonca (https://github.com/melissawm)
- Matti Picus (https://github.com/mattip)
- Ross Barnowski (https://github.com/rossbar)
- Ralf Gommers (https://github.com/rgommers)
- Sebastian Berg (https://github.com/seberg)
Mentored Sprints was created in an open effort to tackle some diversity and inclusion issues in the open-source community. They have been very supportive of us and this sprint, hosting us on their discord server.
- Tania Allard (https://www.mentored-sprints.dev/team/)
- Widen the pool of open-source contributors
- Contribute to NumPy library
- Involve more women and gender minorities in NumPy and open source
- Build momentum for continued contribution
- The plan is to work in pairs/small groups.
- The goal is that each participant will be able to resolve one fix and submit a pull request (PR).
- There is no charge for the sprint. We ask you to donate a nominal amount ($5 to $10) to NumFOCUS to support open source.
- For "Donation Dedication:" indicate "NumPy"
- For "Please notify the following person that a donation has been made:" indicate "[email protected]"
We welcome all genders. We also ask our attendees to respect that this organization and event is a women's space. One example of creating that space is allowing women to speak and ask questions.
- Open an account on GitHub
- Git should be installed
- Some familiarity with Git / GitHub
- Prior to event, review some Git resources
- We will go over pull requests at beginning of event
Discord is a voice, text and video communication platform that allows us to set both text and voice channels. We are using the Mentored Sprints Server on Discord for the sprint to help mentors support participants and enable us to pair program. Participants will be invited to join and connect via the Discord Server during the pre-sprint setup.
A beginners guide to discord can be found here.
Join the WiMLDS community and NumPy on Slack Participants will be invited and encouraged to join both WiMLDS and NumPy on Slack for continued support. See links above under the heading *post-sprint.
3. Read through NumPy Contributing documentation
These steps will be covered at the pre-sprint set up (May 4th 7pm CET).
- It is approx a 30 min read
- The following documentation will help you setup and build a local development environment:
-
There is an alternative option to use the numpy gitpod setup. More information can be found here
-
General guidelines for contributing:
- Contributor guidelines https://numpy.org/devdocs/dev/index.html
- Read through the recommended development workflow
- Read through how-to guide to contributing to NumPy documentation
4. Review Open Issues
- NumPy repository
- There are over 2000 issues 😓
- For the sprint, it is recommended to pick issues found in the middle of the issues stack
- old issues are often difficult to solve or unresolvable which is why they still remain
- very new issues are often taken up very quickly and so someone is likely to already be contributing to them
- Take a look through the issues and become familiar with them
- A list of documentation issues was highlighted by the mentors during the sprint. You can find it here along with other useful tips on how to submit a commit and ultimate PR.
- A sub-set of issues were labelled with sprint-wimlds on the numpy git-repo here.
Here are a few more useful links and guides to follow:
If you are working on documentation, remember to check against https://numpy.org/devdocs - this is the version of the documentation corresponding to the latest development version (aka what is merged on the main branch on github). The https://numpy.org/doc/stable version might be outdated (corresponds to the latest release).
If you worked in a pair/group and want to know how to acknowledge multiple authors on the PR. Find some helpful documentation here
Commit messages should be clear and follow a few basic rules. Please try to label your commits with an indicative label. A guide to best practice can be found [here](https://numpy.org/devdocs/dev/development_workflow.html?highlight=commit message#writing-the-commit-message)
- Numpy contributor Matti Picus's getting involved with Numpy talk for Data Umbrella: https://youtu.be/lHJqOE5j6xE
- Melissa Weber's Talk: Sphinx for Python Documentation: https://youtu.be/tXWscUSYdBs
- Reshama Shaikh's intro to git: https://github.com/reshamas/git-intro-workshop
- A guide to making open source contributions, for first-timers and for veterans: https://opensource.guide/how-to-contribute/
- A guide to pair-programming: https://medium.com/@weblab_tech/pair-programming-guide-a76ca43ff389
- Mentored Sprints Community Handbook: https://mentored-sprints.netlify.app/
If you would like to blog about the event, email us ([email protected]) and we would be happy to share and promote the blog with our community.
Please feel free to tweet about the event.
- @WiMLDS_Berlin
- @wimlds
- @numpy_team
- #NumPySprint
- #opensource