Write Code and Commit
How to create a PR?
To create a PR 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_platform/platform/core/openbb_core/app/constants.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.
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.