When contributing to this repository, please first discuss the change you wish to make via issue with owner or other contributers.
- Before statrting development of any new feature, Always check if this repo is ahead in commits as compared to your fork.
- It is a good practice to always keep your fork up-to-date before starting development of features/fixes to avoid merge conflicts.
- Update your fork using following code snippet.
# Add a new remote repo called as screenipy_upstream
git remote add screenipy_upstream https://github.com/pranjal-joshi/Screeni-py.git
# Sync your fork before starting work
git fetch screenipy_upstream
git checkout <BRANCH_YOU_ARE_WORKING_ON>
git merge screenipy_upstream/<BRANCH_FROM_THIS_REPO_YOU_WANT_TO_MERGE_IN_YOUR_BRANCH>
- This project uses TA-Lib. Please visit the hyperlink for the official guide of installation.
- This Project requires Python 3.9 environment setup. Click Here to Download
- Install python dependencies by running
pip install -r requirements.txt
in the root directory of this project.
- Install pip-chill by running
pip install pip-chill
which is a developer friendly version of classicpip freeze
. - Update the
requirements.txt
file by runningpip-chill --all --no-version -v > requirements.txt
. - Ensure to uncomment all the dependency modules from the
requirements.txt
- Update the test-cases as per the new features from
test/screenipy_test.py
if required. - Run a test locally with
pytest -v
and ensure that all tests are passed. - In case of a failure, Rectify code or Consider opening an issue for further discussion.
- Ensure that dependecy list have been generated in the
requirements.txt
using above section. - Ensure that all test-cases are passed locally.
- If you are contributing new feature or a bug-fix, Always create a Pull Request to
new-features
branch as it have workflows to test the source before merging with themain
.