Contributing Procedure#
Browse issues at ahuang11/ahlive#issues, or submit a new one.
Select the one that interests you.
(Optional) Install Python executable if you don’t already have; example for Linux.:
$ wget https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh $ bash Miniforge3-Linux-x86_64.sh -b $ source ~/.bashrc
(Optional) Create a virtual environment for ahlive.:
$ conda create python=3.9 -n ahlive_dev $ conda activate ahlive_dev
Clone ahlive locally.:
$ git clone https://github.com/ahuang11/ahlive.git
Install ahlive and its dependencies.:
$ cd ahlive $ pip install -e . $ conda env update ci/environment_ci.yml $ pre-commit install
Make changes to the code for fixing the issue.
Commit your changes and push.:
$ git checkout -b "name_of_branch" $ git add . $ git commit -m "your message here" $ git push origin "name_of_branch"
In the pull request text, please provide a link to the GitHub issue.
Wait for tests to pass and a code review if needed.
Merged! Thank you for your contribution!