Skip to content
This repository has been archived by the owner on Aug 19, 2022. It is now read-only.

How to contribute to open source

Sabien edited this page Dec 23, 2019 · 3 revisions

What is Open Source anyways?

Contributing to Open Source project is the foundation of oneleif's core professional development beliefs. For the uninitiated, Open Source projects mean that the project's code and operation is open to the public.

This has tons of benefits for the owner of the project: they project owner gets more help on development, get better feedback, and more eyes on the project.

Those that can see the project gain the benefits of: being able to work on something they care about, learning how something is done, getting a structured project to work on.

I've read this far, how do I get started?

We at oneleif highly recommend submitting your account name using this Google Form so we can add you to our team! Form link: https://forms.gle/yXAHBsUaoMwRzYnR7

So, now you're a member of the oneleif GitHub team! (Check your email for the invite)

To get started working on any of the projects, first you have to choose the repository (the collection of code) to work on.

Forking a project

So, oneleif as a community owns the oneleif website, for example. You as a developer need to either have permissions to add code (permission gained through the aforementioned form) or you need to Fork the repository.

For information regarding forking a repository, see this article from GitHub: https://help.github.com/en/github/getting-started-with-github/fork-a-repo

What do I work on?

You have a copy of our project, and now you need to actually work on something. Well, its as simple as looking at the Projects tab of the repository and picking a ticket that is in the To Do tab!

Submitting code

So, you now have a copy of our repository and you've made a code change, now what?

You will need to submit a Pull Request (a Request for oneleif to Pull your code into our version of the repository).

For information regarding Pull Requests (commonly calls PRs) see the following article from GitHub: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests

I found a bug, what now?!

Awesome, now we need you to take note of this bug!

Head on over to the issues for the project, for example see the following link for the issues of the oneleif website backend/API: https://github.com/oneleif/olWebsite/issues

Do a quick look through of the issues and make sure you aren't making a duplicate. If you don't see any similar issues, add yours with steps to reproduce the bug.