Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

33 lines (27 loc) · 1.39 KB
Raw

Welcome!

First, thank you for considering contributing to this repository.

Here's a list of what has been implemented:

  1. Triggers for bullish orders
  2. Close prices as LTP
  3. Telegram interface
  4. MongoDB interface

Here's what's missing:

  1. A way to authenticate users via telegram app using a token or password.
  2. Option for both bullish and bearish triggers
  3. Option for price i.e. Open, High, Low, Close
  4. A few stock prices can not be retrieved via yfinance library, find them and use alpha vantage API as fallback.
  5. Scrape list of stocks in all Nifty broad market indices, check the list here

What else you can contribute:

  1. Bug reporting
  2. Testing
  3. Spreading the word (the best contribution ever!)

If you are interested on working on any of the above ideas, here's what you can do:

  1. Create an issue and verify the issue has not been taken up by anyone else
  2. Fork and star this repository
  3. Push all your changes to your fork
  4. Verify changes thoroughly and make sure you haven't altered the project file structure
  5. Issue a pull request

Every contributor must follow these guidelines:

  1. Do not make use of any sort of foul language.
  2. Be respectful and do not indulge in any malpractices.
  3. Take extra care about not leaking your telegram bot or alpha vantage token, in case you commit to this repository.