jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-05 08:51:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

update contributing section (#6255)

Browse Source
This commit is contained in:
montezdesousa
2024-03-26 12:09:49 +00:00
committed by GitHub
parent 0f441287b0
commit edc3da968f
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md vendored
View File

@@ -1705,9 +1705,16 @@ The accepted branch naming conventions are:
- `bugfix/bugfix-name`
- `docs/docs-name`
All `feature/feature-name` related branches can only have PRs pointing to `develop` branch. `hotfix/hotfix-name` and `release/*` branches can only have PRs pointing to `main` branch.
All `feature/feature-name` and `bugfix/bugfix-name` related branches can only have PRs pointing to `develop` branch. `release/*` branches can only have PRs pointing to `main` branch, while `hotfix/hotfix-name` should first be merged to `main` and then into `develop` to sync the hotfix changes.
The `docs/docs-name` branch is used to update documentation in-between releases, it will trigger the website deployment to GitHub pages.
When `develop` branch is merged to `main`, a GitHub action will run scripts that generate documentation content (reference sections, data models, etc.) and trigger the website deployment. Those scripts can be found in the following path `website/generate_*.py`.
The `develop` branch is only merged to `main` right before a new release, but sometimes you might need to update the website in-between releases. To do this follow these steps:
1. create `docs/[my-update]` branch from `main`
2. commit your changes to `docs/[my-update]`
3. merge `docs/[my-update]` into `main` -> website deployment triggered
4. merge `docs/[my-update]` into `develop` -> NO website deployment, just to sync branches
## Installers