Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (27 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

42 lines (27 loc) · 1.26 KB

Contributing

How to contribute to easyeda project.

Fork this repository

Fork this repository before contributing. It is a better practice, possibly even enforced, that only Pull Request from forks are accepted - consider a case where there are several main maintainers.

Clone your fork

Next, clone your fork to your local machine, keep it up to date with the upstream, and update the online fork with those updates.

git clone https://github.com/YOUR-USERNAME/easyeda2kicad.py.git
cd easyeda2kicad.py
git remote add upstream https://github.com/uPesy/easyeda2kicad.py.git
git fetch upstream
git merge upstream/dev
git pull origin dev

Note that PR should be done on the dev branch

Install for developers

Create a dedicated Python environment where to develop the project.

If you are using pip follow the official instructions on Installing packages using pip and virtual environments, most likely what you want is:

python -m venv env
source env/bin/activate

Where env is the name you wish to give to the environment dedicated to this project.

Install the package in develop mode.

python setup.py develop