This wiki is automatically published from ohmyzsh/wiki. To edit this page,
go to ohmyzsh/wiki, make your changes and submit a Pull Request.
Oh My Zsh has had contributions from 2,000+ developers across the planet, which is truly amazing and something we're proud of. Yet, there has only been a small handful of developers who have played a big role in organizing, prioritizing, triaging, promoting, and maintaining all these contributions.
As we look ahead to the next few years, we are seeking more volunteers to play different roles.
Interested to learn more?
Given that we know there is a wide range of ways that people could get involved, we have decided to experiment with outlining a framework for how you can get started. Like all open source, this is a Work in Progress (WIP) and we'll be iterating on it as we have questions/feedback pop up.
Tour of Duty
First off, please read our Code of Conduct. 🙃
We are establishing a series of levels so that there is a way for everyone to get an idea of how they can take part.
Level 1: Helper
As a Level 1 volunteer, you can help us by:
- Joining our Discord server and participating in the community conversations that take place.
- Answering questions on StackOverflow relate to Oh My Zsh (and ⬆️ up-voting answers that help you resolve a problem).
- Asking and/or responding in our Github Discussions.
- Follow us on twitter/@ohmyzsh and share useful links to blog articles, tutorials, and/or discussions.
- Help us continue to bring the joy of Oh My Zsh to more people by introducing it to peers!
- ...and be sure to thank the person who introduced you!
Skill(s) needed: You know how to be a delightful human being!
Level 2: Contributor
As a Level 2 volunteer, you can help us by:
- Opening an issue when you encounter inaccurate documentation.
- Improving the readability of our documentation and wiki content.
- Creating a new plugin (can be a custom one you share and/or one to pitch for inclusion).
- Opening an issue when you encounter a weird bug.
- Fixing a weird bug you encountered.
- Helping improve an existing plugin.
- Testing pull-requests that other people have submitted (we usually have a lot to review!).
- Writing a blog post about how to use a favorite plugin of yours and post about it online.
- Recording a screencast and uploading it to places like YouTube.
Skills needed:
- You should be comfortable switching across git branches
- You should be able to test a pull-request out in your local environment
- You should be able to run our linters
Level 3: Triage / Moderator
As a Level 3 volunteer, you can help us by:
- Help us moderate channels in our Discord server.
- Participating in our planning meetings (a few of us meet every other month or so).
- Testing pull-requests from other contributors.
- Providing feedback and/or change requests to people who submit pull-requests.
- Let pull-request submitters know if their proposed plugin, theme, and/or changes might not qualify for inclusion. (TODO: this process requires documentation)
- Suggest pull-requests to Maintainer(s) that you believe are good for us to consider merging.
Skills needed:
- You should be comfortable navigating git merge conflicts
- You should be able to test various plugins across different operating systems, programming languages, frameworks, and CLI tools.
Level 4 / Maintainer
- Keeping an eye out for the long-term maintainability of Oh My Zsh.
- Participating in our planning meetings (a few of us meet every other month or so).
- Prioritizing the backlog of issues and pull-requests for the upcoming cycle(s) using input from Triage volunteers.
- Merging and/or Closing Pull-Requests and Issues in Github.
- Addressing high-priority security incidents and/or bug fixes.
- Helping coordinate communication through our various user channels.
Skills needed:
- You should be able to help us in a project manager capacity.
- You should feel comfortable merging (and/or reverting) big changes to the project.
- ...
Level 5 / Maintainer with Admin access
As a Level 5 volunteer, you might be:
- Doing a little bit of everything
- Recruiting new volunteers
- Steering the toward a bright future
- Managing our Github accounts, settings, projects, and permissions.
This is currently handled by:
In Summary
Does any of this sound like something you might like to contribute to? You can get started today!
If you have any questions, don't hesitate to open up a Github Discussion and we'll follow-up with you there.
Happy Hacking!