Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

First contribution hurdles in .gitignore, workflow, scripts #1109

Open
MusicalNinjaDad opened this issue Jan 12, 2024 · 0 comments · May be fixed by #1122
Open

First contribution hurdles in .gitignore, workflow, scripts #1109

MusicalNinjaDad opened this issue Jan 12, 2024 · 0 comments · May be fixed by #1122

Comments

@MusicalNinjaDad
Copy link

Operating system: Windows11 / WLS2 (Ubuntu 20.04)
Python version: 3.12
Pi model: N/A
GPIO Zero version: N/A
Pin factory used: MockFactory

As a first time contributor I ran into minor issues which required simple adjustments to make developing feasible.
I develop in a simple virtual environment (via python -m venv .venv) for each project leaving my system and user level python untouched, use vscode as an editor and like to have github actions run regression tests on a matrix of versions for each push on every branch

  1. .gitignore doesn't have relevant entries for venv or vscode
  2. .github/workflows/test.yml only triggers on master
  3. the doc preview script uses the system-wide default python and not the virtual environment

While making these minor changes is not a big deal after forking, they need to be excluded from any pull requests - leading to more complicated rebasing before raising a PR and limited testing possible after rebasing. Without the .gitignore changes, git identified 4987 changed files in the branch I created for a PR - which makes it easy to make a mistake.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant