Always happy to review pull requests and merge any fixes, or features, that would help onboardme.
Here's some guidelines on how we code.
Prereqs
-
Install poetry, which we use for dependency management and packaging in python.
-
If using vim/neovim, we recommend installing the jedi language server. onboardme will install it for you with the following:
# if you have existing dot files that you don't mind overwriting, use append -O
onboardme -s dot_files,neovim_setup --git_url https://github.com/jessebot/onboardme.git
-
Install poetry, which we use for dependency management and packaging in python.
-
If using vim/neovim, we recommend installing the jedi language server. onboardme will install it for you with the following:
# if you have existing dot files that you don't mind overwriting, use append -O
onboardme -s dot_files,neovim_setup --git_url https://github.com/jessebot/onboardme.gitOnce you have the pre-reqs installed you can fork the repo and then clone your fork:
# this should be YOUR fork, but for an example, we're using the actual repo
git clone [email protected]:jessebot/onboardme.git
cd onboardmeUse poetry and pre-commit to install onboardme depedencies:
poetry install
pre-commit installNow you can proceed as normal for python development and when you're done, just commit the changes and the pre-commit hooks will run any linting and tests we have. When everything passes, open up a PR against the main repo and we'll get it reviewed :)