mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2024-11-29 03:03:59 +01:00
Adding initial version fo Tour of Duty to Volunteers page. fix #4
parent
368277deda
commit
8aea906141
7
Home.md
7
Home.md
@ -63,5 +63,8 @@ Once Oh My Zsh is installed:
|
|||||||
|
|
||||||
## Help out!
|
## Help out!
|
||||||
|
|
||||||
- Want to contribute? Check out our [[Code Style Guide]] and [[Design]] guidelines and start hacking away!
|
Want to contribute?
|
||||||
- We need [[Volunteers]]. We're improving this section, stay tuned!
|
|
||||||
|
We are looking for [[Volunteers]] of all skill levels.
|
||||||
|
|
||||||
|
Check out our [[Code Style Guide]] and [[Design]] guidelines and start hacking away!
|
||||||
|
101
Volunteers.md
101
Volunteers.md
@ -1,28 +1,103 @@
|
|||||||
> _This wiki is automatically published from [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki). To edit this page,_
|
> _This wiki is automatically published from [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki). To edit this page,_
|
||||||
> _go to [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki), make your changes and submit a Pull Request._
|
> _go to [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki), make your changes and submit a Pull Request._
|
||||||
|
|
||||||
We're having a discussion on the need to have [a few moderators](https://github.com/ohmyzsh/ohmyzsh/issues/2771) as well as having some [general guidelines](https://github.com/ohmyzsh/ohmyzsh/issues/3770) and [help](https://github.com/ohmyzsh/ohmyzsh/wiki/Contribution-Technical-Practices) for new collaborators in the project, whether they want to submit a patch, report a bug or just ask a question. Feel free to write your opinion!
|
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.
|
||||||
|
|
||||||
Please read our [Code of Conduct](https://github.com/ohmyzsh/ohmyzsh/blob/master/CODE_OF_CONDUCT.md), too. 🙃
|
As we look ahead to the next few years, we are seeking more volunteers to play different roles.
|
||||||
|
|
||||||
***
|
Interested to learn more?
|
||||||
|
|
||||||
### Project management
|
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.
|
||||||
|
|
||||||
As you can see by looking at the project, we have a lot of pending Pull Requests and Issues. While there are a number of people helping out by answering Issues and reviewing Pull Requests, I'd like to find 2-3 volunteers to assist me with organizing, reviewing, and helping me work through these.
|
## Tour of Duty
|
||||||
|
|
||||||
#### Pull Requests
|
First off, please read our [Code of Conduct](https://github.com/ohmyzsh/ohmyzsh/blob/master/CODE_OF_CONDUCT.md). 🙃
|
||||||
|
|
||||||
If you're feeling fairly savvy with Oh My Zsh have sent in pull requests/helped test other requests, and know your way about the framework... and want to do this more often, do get in touch with me. If you can volunteer 2-3 hours/week to help go through things, I'd love to speak with you.
|
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.
|
||||||
|
|
||||||
#### Issues
|
### Level 1: Helper
|
||||||
|
|
||||||
Additionally, if you're just wanting to help out... I could use a few people to assist with organizing new Issues. I'd like all the Issues to be properly labeled and assigned to people that can help those items move forward. For example, if a bug comes in for a plugin reaching out to the original plugin author to ask if they can help out would be great. (Basically... poking people and trying to help issues get resolved and/or closed).
|
As a Level 1 volunteer, you can help us by:
|
||||||
|
|
||||||
Get in touch with [@robbyrussell](https://github.com/robbyrussell) and [@mcornella](https://github.com/mcornella).
|
* Joining [our Discord server](https://discord.com/invite/ohmyzsh) and participating in the community conversations that take place.
|
||||||
|
* Answering questions on [StackOverflow relate to Oh My Zsh](https://stackoverflow.com/questions/tagged/oh-my-zsh) (and ⬆️ up-voting answers that help you resolve a problem).
|
||||||
|
* Asking and/or responding in [our Github Discussions](https://github.com/ohmyzsh/ohmyzsh/discussions).
|
||||||
|
* Follow us on [twitter/@ohmyzsh](https://twitter.com/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!
|
||||||
|
|
||||||
### Contributions needed
|
### Level 2: Contributor
|
||||||
|
|
||||||
* Some wiki pages ([[Plugins]], [[Plugins Overview]], _etc_) need updating
|
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 an 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](https://github.com/orgs/ohmyzsh/projects/1/views/29) 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:
|
||||||
|
|
||||||
|
* [@mcornella](https://github.com/mcornella) (official maintainer of Oh My Zsh)
|
||||||
|
* [@robbyrussell](https://github.com/robbyrussell) (creator of Oh My Zsh)
|
||||||
|
|
||||||
|
|
||||||
|
## In Summary
|
||||||
|
|
||||||
|
Does any of this sound like something you might like to contrbiture 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!
|
||||||
|
Loading…
Reference in New Issue
Block a user