Skip to content

Latest commit

 

History

History
118 lines (91 loc) · 3.72 KB

CONTRIBUTING.md

File metadata and controls

118 lines (91 loc) · 3.72 KB

Option Pricer

Repository Assumptions and Guidelines

This repository follows a structured workflow to ensure code quality, stability, and consistency. Below are the key assumptions and guidelines that contributors should follow:

Code Style

  • Follow the C++ Core Guidelines.
  • Use modern C++ best practices.
  • Ensure all new code is covered by unit and integration tests.

Branching Strategy

  1. Main Branch (main):

    • The main branch contains stable, production-ready code.
    • Direct pushes to the main branch are not allowed. All changes must be introduced via pull requests (PRs).
    • Before merging into main, all PRs must pass the CI/CD pipeline and receive necessary approvals.

  2. Development Branch (dev):

    • The dev branch is the primary branch for ongoing development.
    • All feature branches should be created from and merged back into dev.
    • Pushing to dev also triggers the CI/CD pipeline to ensure that ongoing development does not introduce errors.

  3. Feature Branches (feature/*):

    • Feature branches are used for developing new features and should be created from dev.
    • Once a feature is complete and tested, it should be merged back into dev.
    • Example: feature/your-feature-name.

CI/CD Pipeline

  1. Push command and CI/CD:

    • The CI/CD pipeline is triggered by pushes to any branch except main.
    • The pipeline includes steps such as building the project and running the unit tests.

  2. Pull Requests and CI/CD:

    • To merge changes into main, you must create a pull request (PR).
    • A different CI/CD pipeline automatically runs for each PR and runs the integration tests.

Workflow Guidelines

  1. Creating a Feature Branch:

    • Ensure you're on the dev branch: 
      git checkout dev
git pull origin dev
git checkout -b feature/your-feature-name

  2. Committing Changes:

    • Add and commit your changes with descriptive messages: 
      git add .
git commit -m "Add new feature"

  3. Pushing Changes:

    • Push the feature branch to the remote repository to trigger the CI/CD pipeline: 
      git push -u origin feature/your-feature-name

  4. Creating a Pull Request:

    • Navigate to the repository on GitHub.
    • Click on the "Pull requests" tab and "New pull request".
    • Select main as the base branch and your feature branch as the compare branch.
    • Fill in the title and description and click "Create pull request".

  5. Merging a Pull Request:

    • Ensure all CI/CD checks pass and the PR is approved.
    • Merge the PR on GitHub to integrate changes into main.
    • Pull changes from origin/main to local main by calling git pull inside main.

Reporting Issues

If you encounter any issues, please create a new issue on GitHub with a detailed description of the problem.

Example workflows

Feature Development Workflow for dev Branch

  1. Create a feature branch from dev:
git checkout -b feature/your-feature dev
  1. Make changes, add and commit:
git add .
git commit -m "Add new feature"
  1. Push the feature branch to remote to trigger the CI/CD pipeline:
git push -u origin feature/your-feature
  1. After CI/CD passes, merge the feature branch into dev:
git checkout dev
git pull origin dev  # get latest updates
git merge feature/your-feature
  1. Push the updated dev branch:
git push -u origin dev
  1. Delete the feature branch on local and on remote:
git branch -d feature/your-feature
git push origin --delete feature/your-feature

Contact

For any questions and/or contributions, please contact Anthony Makarewicz at [email protected]