Skip to content

Latest commit

 

History

History
91 lines (64 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

91 lines (64 loc) · 2.5 KB
Raw

Contributions

Contributions are always welcome 😄 ! you can contribute in many ways.

Reporting Bugs

Report Bugs at https://github.com/sforaidl/jeta/issues

When reporting bugs please

  • Include the version and some information about your local environment setup.
  • Way to reproduce the bug

Fixing Bugs:

Issues tagged with help wanted, good first issues, and bug are open for everyone.

Get Started

Follow the steps to setup jeta for local development process

  1. Fork the Jeta repo on github

  2. clone your fork on local machine using following terminal command.

git clone https://github.com/<insert your github username>/jeta.git
  1. Create a conda virtual environment and download the dependancies using requirements.txt
conda create -n jeta
conda activate jeta
conda install pip
pip install -r requirements.txt
cd jeta/
pip install -e .
  1. Setup pre-commit hooks To automate the process of formatting code, we have configured the repo with pre-commit hooks to autoformat the staged files to ensure every commit complies with a style guide. This requires some setup, which is described below:
pip install pre-commit
pre-commit install
  1. Updating local branches

Sometimes your local branches might not be in sync with the upstream branches. To update the local branches, run following command

git pull upstream main
  1. Create a branch to work on specific issue, it is always advised to create a new branch from main branch for every new issue/patch.
git checkout -b <branch name for specific issue>

Running above will create a new branch and you will be switched to the new branch.

  1. Add tests for the code you added and check the tests before commiting. To run these tests, run the following command from the root folder of jeta (jeta/)
pytest tests

To run a specific test, say run test_sample from tests folder,

pytest tests/test_sample.py

Refer to the pytest documentation for more details.

  1. Run pre-commit hooks to format your code into proper structure.
pre-commit run --all-files
  1. Commit your changes and push your branch to github
git add .
git commit -m "Description about the changes"
git push origin <branch name>
  1. Open up a pull request on github. If all previous checks and tests pass, please send a pull request. If you are not familiar with creating a Pull Request, here is a guide: