Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

oss.gg | Hacktoberfest 2024 #6703

Merged
merged 7 commits into from
Sep 30, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/oss-gg-hack-submission.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: oss.gg hack submission 🕹️
description: "Submit your contribution for the for the oss.gg hackathon"
title: "[🕹️]"
labels: 🕹️ oss.gg, player submission, hacktoberfest
assignees: []
body:
- type: textarea
id: contribution-name
attributes:
label: What side quest or challenge are you solving?
description: Add the name of the side quest or challenge.
validations:
required: true
- type: textarea
id: points
attributes:
label: Points
description: How many points are assigned to this contribution?
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: What's the task your performed?
validations:
- type: textarea
id: proof
attributes:
label: Provide proof that you've completed the task
description: Screenshots, loom recordings, links to the content you shared or interacted with.
validations:
required: true
2 changes: 1 addition & 1 deletion .github/workflows/gh-branch-name-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:

- name: Check branch name for develop PRs
id: check-develop-branch
if: ${{ steps.branch-names.outputs.base_ref_branch == 'develop' }}
if: ${{ steps.branch-names.outputs.base_ref_branch == 'develop' && !github.event.pull_request.head.repo.fork }}
run: |
if ! [[ "${{ steps.branch-names.outputs.head_ref_branch }}" =~ ^(feature/.*|docs/.*|bugfix/.*|hotfix/.*|release/([a-zA-Z-]+-)?[0-9]+\.[0-9]+\.[0-9]+(rc[0-9]+)?)$ ]]; then
echo "reason=Invalid branch name for a Pull Request to be merged to `${{ steps.branch-names.outputs.base_ref_branch }}` branch. Branches must follow the GitFlow naming convention." >> $GITHUB_OUTPUT
Expand Down
71 changes: 71 additions & 0 deletions examples/COMMUNITY_EXAMPLE_TEMPLATE.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Instructions for Contributors\n",
"\n",
"Welcome to this example notebook for OpenBB! Please follow the steps below:\n",
"\n",
"1. **Fill in the details**: Customize the second cell with the name of the notebook, your GitHub profile link, and a brief description of what your notebook demonstrates.\n",
"2. **Add Your Code**: Make sure to include clean and commented code sections throughout the notebook.\n",
"3. **Test Before Submitting**: Run all cells to ensure the notebook functions as expected.\n",
"4. **Keep it Simple and Clear**: Make your explanations and code as clear as possible for others to follow.\n",
"5. **Run in Colab Button**: Ensure the \"Run in Colab\" button links properly to the notebook. You can test it by clicking the button and verifying it loads your notebook.\n",
"\n",
"Please refer to the documentation at [OpenBB Documentation](https://docs.openbb.co/) for additional guidance.\n",
"\n",
"Remove this cell before submitting your notebook."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## [Notebook Name]\n",
"\n",
"#### Description\n",
"[Briefly describe what this notebook demonstrates, e.g., \"This notebook demonstrates how to backtest a momentum trading strategy using OpenBB's historical data.\"]\n",
"\n",
"#### Author\n",
"[Your Name](https://github.com/[YourGitHubUsername])\n",
"\n",
"[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/OpenBB-Finance/OpenBB/blob/develop/examples/[Notebook_Name].ipynb)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"If you are running this notebook in Colab, you can run the following command to install the OpenBB Platform:\n",
"\n",
"```python\n",
"!pip install openbb\n",
"```\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"from openbb import obb"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "obb",
"language": "python",
"name": "python3"
},
"language_info": {
"name": "python",
"version": "3.9.19"
}
},
"nbformat": 4,
"nbformat_minor": 2
}
64 changes: 64 additions & 0 deletions oss.gg/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
[![image](https://github.com/user-attachments/assets/db4855e3-a94b-49ba-bd93-328caa323bf9)](https://oss.gg)


# Instructions for oss.gg Hacktoberfest 2024 Open Source Contributors

## Overview of OpenBB Quests

At oss.gg Hacktoberfest 2024, we have three types of contributions:

1. **GitHub Issues tagged with `🕹️ oss.gg`** (direct code contributions to this repository)
2. **Code Side-Quests** (tasks that involve coding but contribute to separate repositories or projects)
3. **No-Code Side-Quests** (non-coding tasks, such as writing tutorials, social media posts, etc.)

Each type of contribution has its own process, which we’ll describe below.

---

## How to Submit Code Contributions to this repository (GitHub Issues)

1. Choose an issue from the [GitHub issues page](https://github.com/OpenBB-Finance/OpenBB/issues). The issue should have a `🕹️ oss.gg` label.
2. Comment with the `/assign` command to assign yourself.
3. Open a PR within 48 hours where you reference your issue. The PR should point to the `develop` branch.
4. The project maintainer will review the PR, and once it’s merged, you’ll be awarded your points automatically.

---

## How to Submit Code and No-Code Side-Quests

In the root of the repository, you’ll find a folder called `oss.gg`. Inside this folder, there are two subfolders:

1. **`code_side_quests`**: This folder contains `.md` files for each Code Side-Quest.
2. **`no_code_side_quests`**: This folder contains `.md` files for each No-Code Side-Quest.

For both types of side-quests, you will need to:

- Open the relevant `.md` file for your side quest.
- Add a new entry with the following information:
- Your GitHub name
- A UTC timestamp
- A link to your proof of contribution (e.g., a fork or a new repository for code side-quests, or a blog post for no-code side-quests).

## How to Submit Code Side-Quests

1. Open an issue for your contribution. Use the oss.gg hack submission template.
2. Comment with the `/assign` command to assign yourself.
3. Add your details to the relevant `.md` file in the `code_side_quests` folder (as described above).
4. Open a PR where you reference your issue. The PR should point to the `develop` branch.
5. The project maintainer will review the submission, update the side quest log, and once the PR is merged, points will be awarded.

Note: Code Side-Quests often involve work in other repositories (forks or new projects) and do not contribute code directly to this repository.

## How to Submit No-Code Side-Quests

1. Open an issue for your contribution. Use the oss.gg hack submission template.
2. Comment with the `/assign` command to assign yourself.
3. Add your details to the relevant `.md` file in the `no_code_side_quests` folder (as described above).
4. Open a PR where you reference your issue. The PR should point to the `develop` branch.
5. The project maintainer will review the submission, update the side quest log, and once the PR is merged, points will be awarded.

---

Don’t forget to check your current points at oss.gg/[yourGitHubUsername]

Happy hacking!
29 changes: 29 additions & 0 deletions oss.gg/code_side_quests/1-openbb-integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
**Side Quest**: Integrate OpenBB into a dashboard or web application

**Points**: 300-750 Points

**Task**: Integrate OpenBB into a dashboard framework such as Streamlit or a web application. You can use any relevant functionalities from OpenBB to create a useful and interactive dashboard.

**Proof**: Provide a working demo via a video link and a link to your GitHub repository. The repository must be open source.

Please follow the following schema:

---

» 05-April-2024 by YOUR NAME
» Link to Video: https://youtube.com/...
» Link to Repo: https://github.com/...

---

////////////////////////////

Your turn 👇

////////////////////////////

» 01-October-2024 by YOUR NAME
» Link to Video: https://youtube.com/...
» Link to Repo: https://github.com/...

---
29 changes: 29 additions & 0 deletions oss.gg/code_side_quests/2-custom-backend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
**Side Quest**: Create a custom backend for OpenBB Terminal using widgets.json and a new data source

**Points**: 300-750 Points

**Task**: Build a custom backend for OpenBB’s Terminal by utilizing `widgets.json` and integrating it with a new data source. Look at the examples in the [backend-for-terminal-pro](https://github.com/OpenBB-finance/backend-for-terminal-pro) repository to guide your work.

**Proof**: Provide a working demo via a video link and a link to your GitHub repository. The repository must be open source.

Please follow the following schema:

---

» 05-April-2024 by YOUR NAME
» Link to Video: https://youtube.com/...
» Link to Repo: https://github.com/...

---

////////////////////////////

Your turn 👇

////////////////////////////

» 01-October-2024 by YOUR NAME
» Link to Video: https://youtube.com/...
» Link to Repo: https://github.com/...

---
29 changes: 29 additions & 0 deletions oss.gg/code_side_quests/3-custom-copilot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
**Side Quest**: Create a custom copilot for OpenBB Terminal

**Points**: 300-750 Points

**Task**: Create a custom copilot that integrates a new language model (e.g., Cohere, Llama3.2, etc.) into OpenBB's Terminal. Look at the examples in the [copilot-for-terminal-pro](https://github.com/OpenBB-finance/copilot-for-terminal-pro) repository for guidance.

**Proof**: Provide a working demo via a video link and a link to your GitHub repository. The repository must be open source.

Please follow the following schema:

---

» 05-April-2024 by YOUR NAME
» Link to Video: https://youtube.com/...
» Link to Repo: https://github.com/...

---

////////////////////////////

Your turn 👇

////////////////////////////

» 01-October-2024 by YOUR NAME
» Link to Video: https://youtube.com/...
» Link to Repo: https://github.com/...

---
29 changes: 29 additions & 0 deletions oss.gg/code_side_quests/4-agentic-agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
**Side Quest**: Create an AI Agent that utilizes OpenBB

**Points**: 300-750 Points

**Task**: Develop an AI agent that utilizes OpenBB’s features for data analysis, financial insights, or other related tasks. Refer to the [openbb-agents](https://github.com/OpenBB-finance/openbb-agents) repository for examples and guidance.

**Proof**: Provide a working demo via a video link and a link to your GitHub repository. The repository must be open source.

Please follow the following schema:

---

» 05-April-2024 by YOUR NAME
» Link to Video: https://youtube.com/...
» Link to Repo: https://github.com/...

---

////////////////////////////

Your turn 👇

////////////////////////////

» 01-October-2024 by YOUR NAME
» Link to Video: https://youtube.com/...
» Link to Repo: https://github.com/...

---
38 changes: 38 additions & 0 deletions oss.gg/no_code_side_quests/0-set-upper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
**Side Quest**: Record your onboarding and first steps with OpenBB Terminal

**Points**: 150 Points - 300 Points

**Task**: Record yourself going through the setup of OpenBB for the first time and provide feedback. Depending on how much feedback you provide, we’ll assign 150 or 300 points.

You do not need to show your face if you don’t want to, but voice is required. Please say out loud what you’re thinking or expecting as you go.

What should be included:

- Sign up on pro.openbb.co
- Going through the onboarding process in OpenBB Terminal
- Exploring and trying out key features in OpenBB Terminal (e.g., loading data, creating a dashboard, etc.)
- Adding your own data to OpenBB Terminal (e.g., adding a file, adding an API endpoint, OpenBB Platform API, custom backend, etc.)

If you get stuck or encounter issues, please report that in the video. Honest feedback, even if you're unable to complete certain steps, is valuable.

**Proof**: Paste your video or add a link (YouTube, Loom, etc.) in the PR description. If you have more feedback that is not mentioned in the video, please add it in the PR as well.

Please follow the following schema:

---

» 05-April-2024 by YOUR NAME
» Link to Video: https://youtube.com/...

---

////////////////////////////

Your turn 👇

////////////////////////////

» 01-October-2024 by YOUR NAME
» Link to Video: https://youtube.com/...

---
27 changes: 27 additions & 0 deletions oss.gg/no_code_side_quests/1-pilot-copilot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
**Side Quest**: Create a YouTube Tutorial for Custom Copilot Development and Setup

**Points**: 300 Points

**Task**: Produce a step-by-step YouTube video tutorial on setting up and using OpenBB’s custom copilot framework with a real-life example.

**Proof**: Add a link to your YouTube video in the PR description and update the list below with the submission.

Please follow the following schema:

---

» 05-April-2024 by YOUR NAME
» Link to YouTube video: https://youtube.com/...

---

////////////////////////////

Your turn 👇

////////////////////////////

» 01-October-2024 by YOUR NAME
» Link to YouTube video: https://youtube.com/...

---
27 changes: 27 additions & 0 deletions oss.gg/no_code_side_quests/2-fundamental-blog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
**Side Quest**: Write a Use-Case Blog for OpenBB in Fundamental Analysis

**Points**: 300 Points

**Task**: Create a detailed blog post showcasing how OpenBB can be used for fundamental analysis in stock markets.

**Proof**: Add a link to your blog post in the PR description and update the list below with the submission.

Please follow the following schema:

---

» 05-April-2024 by YOUR NAME
» Link to Blog Post: https://medium.com/...

---

////////////////////////////

Your turn 👇

////////////////////////////

» 01-October-2024 by YOUR NAME
» Link to Blog Post: https://medium.com/...

---
Loading
Loading