Getting started#

Jupyter Accessibility is an open community made up of people all over the world. We invite participation of all forms - whether that be contributing design, code, advice, documentation, support, or joining our conversations!

If you’d like to start getting involved with Jupyter Accessibility projects, here are a few resources to get you started.

Tip

Make sure to check the Joining the Jupyter Accessibility Community section in this compass to learn more about where the accessibility conversations are happening in our ecosystem.

Do I really have something to contribute to Jupyter Accessibility?#

Absolutely ✅. There are always ways to contribute to this community!

Access-centered practices require many skills, which means there are many ways in which you can help out. Some examples include: providing feedback in issues, participating in the Jupyter Accessibility Discourse, sharing your experience with Jupyter tools and their accessibility and usability features in an issue, improving documentation, helping others with their problems, telling others about Jupyter Accessibility tools, and coming to our community meetings.

If you are new accessibility practices, then contributing to Jupyter Accessibility is a great way to learn. The Jupyter Accessibility community works hard to share its knowledge of both Jupyter tools and the general problems that they try to solve, and we’d be happy to help you out.

If you’re not sure where to start, look for the Shield badge -Good First Issue in our accessibility repository tag to begin your journey learning about accessibility within the Jupyter ecosystem.

Contributing through GitHub#

git is a really useful tool for version control. GitHub sits on top of git and supports collaborative and distributed working.

You’ll use Markdown to chat in issues and pull requests on GitHub. You can think of Markdown as a few little symbols around your text that will allow GitHub to render the text with formatting. For example, you could write words as bold (**bold**), or in italics (*italics*), or as a link ([link](https://github.com/jupyter/acce)) to another webpage or resource.

Tip

GitHub has a helpful page on getting started with writing and formatting Markdown on GitHub.

Find issues to work on#

If you’d like to make contributions to one of the Jupyter repositories (this can be either contributing code, commenting on issues, reviewing pull requests, or improving documentation), we recommend checking out the issue tags to find issues that are a good place to start.

Practices across projects vary - but in general folks try to use tags to signal different types of issues. Two of such tags that you might be interested in are help wanted, and good first issue.

The GitHub Issues Search can be used to quickly search across all the issues in a GitHub organization that match one of these tags. Here are a few pointers of issues you might want to look for to help you get started:

  • Badge - issue tag Help Wanted: These issues contain a task that a member of the team has determined we need additional help with.

  • Badge - issue tag Good First Issue: These issues contain a task that a member of the team thinks could be a good entry point to the project.

Help by contributing to a specific repository#

Note that the Jupyter Accessibility team works across many kinds of technologies and projects. The kind of tech you’ll use (as well as the set-up and skill needed to work on that tech) will depend on the repository that you’re working with.

For example, the JupyterLab repository will touch on aspects of the UI itself and tools like Lumino and Galata.

To get oriented with a specific repository’s needs and process around making new contributions, look for a repository-specific contributing guide. This often comes in the form of a CONTRIBUTING.md file, or a section of the documentation. For example, here is the CONTRIBUTING.md file for JupyterLab.

Tip

You can also make use of the contribute slug in GitHub - for example to get a list of good first issue labelled issues and the link to the projects CONTRIBUTING guidelines you can append the contributre slug to the repository URL. So for the JupyterLab repository you’d use https://github.com/jupyterlab/jupyterlab/contribute

Are the contributing docs unclear or misleading? Then please let us know! We try to make this documentation as helpful as possible, but we often don’t have the perspective of a new member to the community. Your input is extremely valuable in making it as smooth as possible for others to join our ever-growing community!

Thank you!#

You’re awesome 👋🏻😊.


— Based on contributing guidelines from the STEMMRoleModels and JupyterHub projects.