Skip to content

Commit

Permalink
feat: Update readme for general audience (#435)
Browse files Browse the repository at this point in the history
* Update readme for general audience

* Fix spelling

* Clarify role

* Add PR template we use for VCIO

* Prettified Code!

---------

Co-authored-by: BekahHW <[email protected]>
  • Loading branch information
BekahHW and BekahHW authored Sep 29, 2024
1 parent 940adc5 commit ba3b15d
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 8 deletions.
45 changes: 45 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## Linked Issue

<!--
If you have a pull request related to a current issue please link to that issue number.
That issue can be linked to the pull request by using the side panel in the Github UI or using the `#` symbol followed by the number of the associated issue.
To link a pull request to an issue to show that a fix is in progress and to automatically close the issue when someone merges the pull request, type the keyword "Closes" followed by a reference to the issue. For example, Closes #404 or Closes Virtual-Coffee/virtualcoffee.io/issues/404.
-->

## Description

<!--
A pull request description describes what constitutes the Pull Request and what changes you have made to the code.
It explains what you've done, including any code changes, configuration changes, migrations included, new APIs introduced, changes made to old APIs, any new workers/crons introduced in the system, copy changes, and so on. You get the gist.
A good description informs everyone that is reaading it of the purpose of the pull request. This helps not just the current maintainers but anyone reading it now or in the future to understand your intent.
If the request is not complete but you want feedback use Draft Pull Request option of the Pull request dropdown menu.
@mention individuals that you want to review the PR, and mention why. (“ @username I want to know what you think of this code.”)
-->

## Methodology

<!--
This section explains why the above changes explained were done.
Sometimes a developer feels that it's okay to write "Business/Product requirement" in the description. That's fine, but doing so defeats the purpose of this section.
If there is a better explanation as to why the changes were suggested, it's always good to attach a document reference link for that information.
A good "Why" section should explain the reasoning behind any changes.
-->

## Code of Conduct

> By submitting this pull request, you agree to follow our [Code of Conduct](https://virtualcoffee.io/code-of-conduct/)
47 changes: 40 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
# Virtual Coffee Contributors
# Virtual Coffee Community Building Resources

Management and coordination for Virtual Coffee Contributors
Welcome to Virtual Coffee's community building resources! This repository contains documentation, procedures, and insights into how we manage various aspects of our tech community. Whether you're looking to understand how we do things at Virtual Coffee, volunteer at Virtual Coffee, start your own community or improve an existing one, we hope these resources will be valuable to you.

## About Virtual Coffee

Virtual Coffee's mission is to be a welcoming tech community that allows room for growth and mentorship at all levels and to create meaningful opportunities for learning, leadership, and contribution for everyone.

We prioritize supporting one another and believe in the power of learning and teaching at every level. To learn more about who we are, visit our [website](https://virtualcoffee.io/about).

## Quick Links & Team Leads

This repository is organized into several key areas of community management:

- [How to Use This Repo](#how-to-use-this-repo)
- [Lunch & Learns](./lunch-and-learns): Docs and reference for managing Lunch & Learn events
- **Lead**: Shelley McHardy
- [Coffees](./coffees): Docs and reference for managing weekly Coffees
- **Leads**: Core Maintainers
- **Leads**: Community Maintainers
- [Lightning Talks](./lightning-talks): Docs and reference for helping out with Lightning Talks
- [Monthly Challenges](./monthly-challenges): Docs and reference for managing Monthly Challenges
- **Leads**: Ayu Adiati and Dominic Duffin
Expand All @@ -17,7 +25,6 @@ Management and coordination for Virtual Coffee Contributors
- [Procedures](./procedures): Procedures for various Virtual Coffee tasks
- [YouTube](./procedures/youtube.md): Steps for posting to YouTube
- [Streaming](./procedures/streaming.md): Steps for streaming from Zoom to YouTube Live
- **Lead**: Bogdan
- [Add a Coffee Table Group](./procedures/add-coffee-table-group.md): Steps for adding a new Coffee Table Group after receiving an application
- [Documentation Team](https://github.com/Virtual-Coffee/VC-Community-Docs/blob/main/docs/roles-and-responsibilities/team-leads.md#documentation-team-lead)
- **Lead**: Ayu
Expand All @@ -26,10 +33,36 @@ Management and coordination for Virtual Coffee Contributors

This repo is meant to help facilitate communication and coordination for Virtual Coffee Contributors.

In general, there will be an entire docs section (as well as issue templates, project boards, etc.) for each area of responsibility.
1. **Explore**: Browse through the different folders to find areas of interest.
2. **Learn**: Each section contains documentation on how we approach different aspects of community building.
3. **Adapt**: Feel free to use these resources according to our license as inspiration or templates for your own community initiatives.
4. **Contribute**: If you have suggestions or improvements, please see our [Contributing Guide](./CONTRIBUTING.md).

## Community Building Insights

Throughout this repository, you'll find insights into:

- Creating welcoming spaces for developers of all levels
- Organizing and managing regular community events
- Creating leadership and volunteer opportunities
- Maintaining community documentation
- Balancing growth with community intimacy

## Get Involved with Virtual Coffee

If you're interested in joining Virtual Coffee or learning more about our community:

- Visit our [website](https://virtualcoffee.io)
- Check out our [membership information](https://virtualcoffee.io/join)
- Explore our [public resources for developers](https://virtualcoffee.io/resources)

## Questions or Feedback?

If you have questions about our processes or want to discuss community building, feel free to open an issue or start a [discussion](https://github.com/Virtual-Coffee/VC-Community-Docs/discussions) in this repository. We're always happy to connect!

If you have a question or general observation, the [Contributors team discussion board on GitHub](https://github.com/Virtual-Coffee/VC-Community-Docs/discussions) would be a great place to start.
We hope these resources are helpful. Remember, every community is unique, so adapt these ideas to fit your specific needs and values. Happy community building!

Any changes to this repo need to be via a Pull Request (you can do this on your machine or through the GitHub web interface).
> [!NOTE]
> Any changes to this repo need to be via a Pull Request (you can do this on your machine or through the GitHub web interface).
> ⚠️ **Heads up!** If you'd like to make a change to this repo's docs, please make sure you've started with an issue (or a discussion board post) first, and that you've been assigned to the issue. This allows the maintainer team to provide guidance and prioritize tasks - otherwise you may run the risk of spending time on something that doesn't end up getting accepted for various reasons. Read our [Contributors' Guide](./CONTRIBUTING.md) for more info.
2 changes: 1 addition & 1 deletion coffees/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The Room Leaders are the conversation facilitators of the breakout rooms. They g

- [Room Leader docs](./RoomLeaders-ConversationFacilitators)

### Note Takers:
### Notetakers:

Notetakers take notes on the conversation in the breakout rooms, grab the links that are dropped, and post the notes to slack after Coffee.

Expand Down

0 comments on commit ba3b15d

Please sign in to comment.