virtual-coffee / open-source

A safe, welcoming space for developers to learn good practice for collaboration and try their hand at making contributions to OSS. Maintained by the Virtual Coffee Slack group.

Virtual Coffee Open-Source

This repository serves as a resource for developers at all levels interested in learning Open Source Software best practice and methodology. We hope it can become a welcoming and educational space for developers who want to get more experience in contributing to open source projects.

This project was an organic initiative by attendees of the virtual coffee meetup who all found that the typical OSS experience is not very friendly to people unfamiliar with OSS contributions.

What is Virtual Coffee?

Virtual Coffee is a bi-weekly online meetup where developers of all types, backgrounds, and experience meet up to discuss basically anything and everything so they can learn and grow from each other's experiences. The path of a software developer can often be arduous and uncertain and having a community of peers to interact with can help all of us grow as competent and confident engineers.

Features

As of right now, this repo is simply a hosting place for resources and examples, starting with this README, which will eventually serve as an example for well, a good README. Our contributors may decide to add accompanying web platform functionality in the future.

Contributing

Being able to contribute is one of the core reasons the Virtual Coffee folks wanted to create this space.

See this project's contributions file for a full breakdown of how you can add to the repository!

Also check out the wonderful article How to contribute to open source by Janessa Tran

Projects

Projects related to the Virtual Coffee community or recommended by virtual coffee members that you can contribute to.

• Footnote. An iOS app written with Swift and SwiftUI. Current tasks include accessibility support and supporting multiple platforms, although new features of any kind are encouraged.

• Gisla It’s a distributed saga coordinator app created by the illustrious James Carman.

• Free Code Camp Newbie Friendly Issues Free Code Camp maintains a nice list of issues new folks can get started on.

• Moms-Learn-Tech Resources for moms coming back into the tech field or learning to code for the first time by Bekah Hawrot Weigel

• Horcrux Split your file into encrypted fragments so that you don't need to remember a passcode. Created by Jesse Duffield and recommended by Gant Labourde.

• Forem Browser Extension The Forem browser extension which allows users to seamlessly navigate between communities. Submitted by Nick Taylor

• Ifme Free, open source mental health communication web app to share experiences with loved ones.

• Good First Issues With Next.js Highlighting good issues for first timers in the Next.js repo. Suggested by Nick Taylor.

• Free Code Camp Beginner Issues in the Free Code Camp open source repository, submitted by Bekah Hawrot Weigel

• Drone and Drone Documentation Most Starred OSS Continuous Integration tool created by Brad Rydzewski. Suggested by Marie Antons, reach out directly on Slack or join the Harness Community Slack to get assistance contributing

Acknowledgments

A special thank you to all the members of the Virtual Coffee community who donate their time, labour, and love to making the tech community a better place.

open-source's Issues

Rename master branch to main.

Rename master branch to main.

https://www.hanselman.com/blog/EasilyRenameYourGitDefaultBranchFromMasterToMain.aspx

creating a contributions file

Expanding contributions into its own file, and expanding on how to properly add features. Key considerations:

• People interested in contributing should check existing issues first
• Pull requests should be attached to an accompanying issue. If your PR doesn't address any issue currently listed, make one!
• Links to easy to parse resourced for creating issues and pull requests

Clarify readme

It's possible this repo will just be folded into virtualcoffee.io, but if it will persist we should clarify the purpose and readme to avoid confusion

Add A Resource

If you have a resource to add to the Resources.md file, check out the headings to see if it fits into an existing category (if not, feel free to add your own) and then use the following format to add it:

[Name of the resource](the Link) - a brief description. Add by [Your name](link to your github user)

Creating a file to store resources

For now we're looking at a simple file or folder to hold the links discussed in the virtual coffee slack channel. Something along the lines of a resources.md

If it starts off as just a data dump that's okay, but hopefully soon we can settle on a simple template with instructions on how to update the list.

A good start would be just if we had the link and the associated person who shared it.

e.g.
Step by Step to contributing on github - Submitted by TK

Create Readme.md

Create a readme that guides future contributions, explains the purpose of this repository, etc.

Consider adding an issue template to the repository

Description

I came to add an issue to the repository and realized there was no issue template.

Solution

Incorporate a GitHub issue template. Optional would be to have multiple templates based on the type of issue, e.g. feature, bug fix.

Expected Behaviour

When a contributor creates a new issue, they are presented with an issue template.

Screenshots

Here is an example of an issue template from the Forem repository.

Resources

Configuring issue templates for your repository

Member profiles do not line up when profile information is missing

Description

On the members page, if there is missing GitHub profile information, the member's profile becomes oout of line with the rest of the members

Solution

Take into account empty member profile information when spacing the member profile information.

Expected Behaviour

All member profiles should line up properly.

Screenshots

Here is a screenshot of the issue.

Resources

• Flexbox
• CSS Grid

Having a proper license file

We should be clear on what type of OSS we're trying to be. Since this repo intends to have a lot of external resources, we're probably looking at something as free as possible? By definition, this repository should be avoiding monetisation/proprietization.

Add Project to the List of OS Projects

I have always had a list of random resources that I kept on GitHub as a sort of non-browser specific bookmark list.

Thought it would make a great OS project that anyone could contribute to with their own resources.

https://github.com/saramccombs/dev-resources

While I don't have the time at the moment to add it, I thought I'd create an issue to get it added in case someone has time before I do.

Please tag me as the reviewer should you take on this issue.

Cheers!