mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 04:52:07 +00:00
3a8a71dd15
* This change creates a PR * start moving stuff around * data_models/_category_.json * reference/_category_.json * moving some stuff around * Introduction * Documentation updates * few broken links, clean up sidebar titles for how-to * codespell * quickstart - new provider extension * add a comment * map provider interface * quickstart for new router extension * [Docs] diataxis refactor refactor (#6425) * Start refactor * Edits * [DOCS] Reorganize and edit. Fix sidebar navigation (#6445) * Reorganize and edit. Fix sidebar navigation * Fix broken linkages * Edit --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> * Fix links --------- Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> * Fix broken links * Reword CLA part in the Licensing FAQ * change titles and order suggestion - cc @IgorWounds @piiq --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> Co-authored-by: hjoaquim <henriquecjoaquim@gmail.com>
67 lines
2.2 KiB
Plaintext
Vendored
67 lines
2.2 KiB
Plaintext
Vendored
---
|
|
title: GitHub
|
|
sidebar_position: 10
|
|
description: This page outlines working with GitHub, including branch naming conventions and information related to creating a pull request.
|
|
keywords:
|
|
- Commit changes
|
|
- PR creation
|
|
- Branch naming conventions
|
|
- Commit guidelines
|
|
- GitHub
|
|
- contributing
|
|
- submission
|
|
- cheat sheet
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="GitHub - User Guide | OpenBB Platform Docs" />
|
|
|
|
This page covers working with the GitHub repository, and contributing code via a pull request.
|
|
|
|
## GitHub Cheat Sheet
|
|
|
|
See the page [here](https://training.github.com/downloads/github-git-cheat-sheet/) for a GitHub cheat sheet.
|
|
|
|
## Merge Conflicts
|
|
|
|
If you have installed the OpenBB Platform in editable mode (i.e, with `dev_install.py`), you may encounter merge conflicts when switching branches. They will most likely originate from the static assets automatically generated for the Python interface, and are in the folders:
|
|
|
|
- `/openbb_platform/openbb/assets`
|
|
- `/openbb_platform/openbb/package`
|
|
|
|
Discard any changes within and they will be regenerated upon the next initialization.
|
|
|
|
Alternatively, `git stash` will do the trick.
|
|
|
|
## Contributing
|
|
|
|
Code contributions are made by creating a pull request on GitHub. Branches should typically be created from the `/develop` branch, and they should be named according to the conventions described next section below.
|
|
|
|
### Branch Naming Conventions
|
|
|
|
Before creating a new branch, switch to the `develop` branch and update your local cloned repo.
|
|
|
|
```console
|
|
git fetch
|
|
git checkout develop
|
|
```
|
|
|
|
If there are conflicting changes with the develop branch, `stash` the local changes first.
|
|
|
|
To submit a PR, a local branch or fork must be named according to the naming conventions:
|
|
|
|
- `feature/feature-name`
|
|
- `bugfix/bugfix-name`
|
|
- `docs/docs-name`
|
|
|
|
These branches can only have PRs pointing to the `develop` branch.
|
|
|
|
### Create Pull Request
|
|
|
|
A pull request should contain descriptions and details of all proposed changes, with any details maintainers and testers will need to know.
|
|
|
|
Please use one of the supplied Pull Request Templates.
|
|
|
|
Linting errors should be cleared, and any tests related to the changed files should be passing.
|