Files
OpenBB/website/content/platform/contributing/platform-development/create_pr.md
Igor Radovanovic 31c673db8f Add some SEO and QA
2023-10-02 15:22:19 +02:00

1.4 KiB
Vendored

title, sidebar_position, description, keywords
title sidebar_position description keywords
Create a Pull Request 5 How to create a Pull Request
openbb
platform
introduction
pull request
contributing
documentation

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

To create a PR to the OpenBB Platform, you'll need to fork the repository and create a new branch.

  1. Create your Feature Branch, e.g. git checkout -b feature/AmazingFeature
  2. Check the files you have touched using git status
  3. 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.
  4. 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-name
  • hotfix/hotfix-name

These branches can only have PRs pointing to the develop branch.