mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 13:01:38 +00:00
1.5 KiB
Vendored
1.5 KiB
Vendored
title, sidebar_position, description, keywords
| title | sidebar_position | description | keywords | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Create a Pull Request | 5 | Learn how to create a Pull Request to the OpenBB Platform. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
To create a Pull Request to the OpenBB Platform, you'll need to fork the repository and create a new branch.
- Create your Feature Branch, e.g.
git checkout -b feature/AmazingFeature - Check the files you have touched using
git status - Stage the files you want to commit, e.g.
git add openbb_terminal/stocks/stocks_controller.py openbb_terminal/stocks/stocks_helper.py. Note: DON'T add any files with personal information. - Write a concise commit message under 50 characters, e.g.
git commit -m "meaningful commit message". If your PR solves an issue raised by a user, you may specify such issue by adding #ISSUE_NUMBER to the commit message, so that these get linked. Note: If you installed pre-commit hooks and one of the formatters re-formats your code, you'll need to go back to step 3 to add these.
Install pre-commit hooks
To install pre-commit hooks, run pre-commit install in the root of the repository.
Branch Naming Conventions
The accepted branch naming conventions are:
feature/feature-namehotfix/hotfix-name
These branches can only have PRs pointing to the develop branch.