-
Notifications
You must be signed in to change notification settings - Fork 14
Open
Labels
featureNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomers
Description
Instructions
Replace all example values below with your actual implementation details. Do not keep the examples as-is. Make
sure to read the full documentation before contributing.
FMP Docs Link:
Replace with the direct link to the relevant endpoint in the Financial Modeling Prep docs
https://site.financialmodelingprep.com/developer/docs#peers-bulk
Parameters:
Replace with the required and optional endpoint parameters (or N/A)
- Required: none
- Optional: none
Proposed model class name:
Replace with the name of the model class you plan to add
FmpStockPeers
Proposed client class name:
Replace with the name of the client class
FmpBulkClient
Proposed client method names:
Replace with the method names in the client
- peers()
Requirements
All models
- start with
Fmp - are implemented as Java 16+ records
- implement the
FmpModelinterface - have
serialVersionUID - have test:
is_serializable - have test:
serializes - use date time classes for dates, instead of strings, where appropriate
- use value objects, instead of strings, where appropriate
- have
*TestDataintestFixtures
All services
- use the model name +
Servicesuffix - are added to the appropriate FmpClient
- have tests with real responses from FMP
- with responses stored as JSON in
testFixtures(for large responses, include only an excerpt)
General
- aim for 100% test coverage; TDD is preferred
- double-check your work before creating a PR
- refactor unrelated code in a separate PR from feature or bugfix changes (don’t refactor "as you go")
- adhere to the existing code style
Metadata
Metadata
Assignees
Labels
featureNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomers