Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

70 lines (47 loc) · 2.83 KB
Raw

Contribution Guidelines for Hudson and Thames ArbitrageResearch

Thank you for considering contributing to Hudson and Thames ArbitrageResearch project! We value your time and effort in helping improve our project. Please follow these guidelines to ensure a smooth contribution process for everyone involved.

Getting Started

The best way to contribute to this project is by adding example notebooks that explain a feature or a strategy in the ArbitrageLab library.

Ideally you should start by checking out the other notebooks in the repo to see if your notebook follows the presentation standards of these notebooks.

Some key points to pay particular attention to are always starting your explantion with an abstract or introduction to the topic and problem statement, using data to explain how the strategy or a particular approach solves the problem and generally concluding with a summary.

Make sure to provide references to papers, articles and journals where the idea was first proposed at the end of the notebook.

Use LaTeX to write mathematical formula and equations.

How to Contribute?

Please follow these steps to contribute:

  1. Fork the Repository

    • Go to the GitHub page of Hudson and Thames ArbitrageResearch and click the "Fork" button at the top right corner.

  2. Clone Your Fork

    • After forking, clone the repository to your local machine to start working on your notebook: 
      git clone https://github.com/your_username/arbitrage_research.git
cd arbitrage_research

  3. Create a Branch

    • Create a new branch for your notebook: 
      git checkout -b feature/your_feature_name

  4. Add your notebook Locally

    • Commit your notebook with a clear commit message: 
      git commit -m "your commit message"
    • Make sure your presentation follows the coding standards of the existing notebooks.

  5. Submit a Pull Request

    • Push your changes to your fork: 
      git push origin feature/your_feature_name
    • Submit your pull request for review to the main branch.

Code Review

Your pull request will be reviewed by maintainers who may provide feedback or request changes. Keep an eye on your GitHub notifications and respond promptly to comments.

Acceptance Criteria

You pull request will be accepted if your notebook follows the coding and presentation standards and the code runs without any error.

Final Steps

Once your pull request is approved and merged, you are officially a contributor. Congratulations! We encourage you to continue participating in our community and consider tackling other issues or improving documentation.

For any questions or help with getting started, don't hesitate to reach out through our community forums or issue tracker.

Thank you for contributing to Hudson and Thames ArbitrageResearch!