CONTRIBUTING

References / Pre-requisites

Code opener CLI uses Typer, which is package used to build great CLI's
Code opener CLI package is build using Poetry, which makes Python packaging and dependency management easy

In order to start, Fork the project (You can also star it if you liked it 🌟)
Install poetry from here or simply using pip install poetry
Clone the Forked repo and go inside the project using cd code-opener-cli
Install all dependencies using poetry install(This will also create Virtual env)
Check whether the virtual env is created using poetry env info
Change the virtual env using poetry env use /path. You will get /path using the poetry env info --path or poetry env info. In case if this dosen't work you can change the interpreter path with above path.
Now, you can start the development, also don't forget to create an Issue here before starting work on anything

Use poetry install to install the package locally inside your Virtual Environment
Test locally whether your package works correctly.
Create wheel package using poetry build
Test the wheel using pip install --user /path/to/wheel/file/inside/dist
Make sure you have written tests for the new code added
Also correct the previously broken test case if any . I have used pytest so you can use pytest to run tests
Now you can create a PR 😅

Thank you for your contributions 😊

Currently the project dosen't use any linter, which will be added soon, but till then make sure you add comments to each file, function, class or any where it is required
Make sure to write appropriate commit message
Also link the PR to Issue using Keyword. For more information you can refer this