For all the devs out there willing to contribute to DVC, here is a quick guide to contributing to iterative/dvc repo
π Open a new issue
π» Set up a dev environment
π΄ Fork iterative/dvc
π§ͺ Add tests and run them locally
β¬οΈ Submit a pull request
@iterativeai
𧡠[1/7]
π Open a new issue
Open a new issue in the issue tracker, whether it be a bug report or a feature request. ππ½
github.com/iterative/dvc/β¦
π§΅[2/7]
π΄ Fork iterative/dvc
Fork iterative/dvc and then clone it into your local computer to start contributing.
π§΅[3/7]
π» Set up a dev environment
Make sure that you have Python 3.8 or higher installed. Install DVC in editable mode with βpip install -e ".[all,tests]" '.
All this is preferably in a virtual environment.
𧡠[4/7]
π§ͺ Add tests and run them locally
We have unit tests in "tests/unit/" and functional tests in "tests/func/". Consider writing the former to ensure complicated functions and classes behave as expected.
The simplest way to run tests is using the command "python-m tests".
𧡠[5/7]
Well done π. Weβre just about thereβ¦
β¬οΈ Submit a pull request
And finally, submit a pull request, referencing any issues it addresses and get it reviewed and merged. π
π§΅[6/7]
β€οΈThanks for reading
We all could make #DVC more helpful for everyone together π€
Go ahead, fork DVC and try resolving an issue ππ½
github.com/iterative/dvc
𧡠[7/7]
Share this Scrolly Tale with your friends.
A Scrolly Tale is a new way to read Twitter threads with a more visually immersive experience.
Discover more beautiful Scrolly Tales like this.