Skip to content

CONTRIBUTING.md suggested changes #2675

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.

Sign up for GitHub

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

CONTRIBUTING.md suggested changes #2675

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f4d5079
Add note on Python versions
tsadler1988 May 23, 2025
a2f17e3
Add note on C compiler
tsadler1988 May 23, 2025
2494ad8
venv activation for PowerShell
tsadler1988 May 23, 2025
c7412a5
Add PyfaDEV path for translations and database scripts
tsadler1988 May 23, 2025
8afb213
venv activation for PowerShell (running tests)
tsadler1988 May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Requirements

- Python 3.11
- Python 3.11 (later versions may not work)
- Git CLI installed
- Python, pip and git are all available as command-line commands (add to the path if needed)

Expand All @@ -26,6 +26,7 @@ Activate the virtual environment

```
For cmd.exe: PyfaEnv\scripts\activate.bat
For PowerShell: PyfaEnv\Scripts\Activate.ps1
For bash: source <venv>/Scripts/activate
```
> For other OS check [Python documentation](https://docs.python.org/3/library/venv.html)
Expand All @@ -36,15 +37,17 @@ pip install -r PyfaDEV\requirements.txt
```
> For some Linux distributions, you may need to install separate wxPython bindings, such as `python-matplotlib-wx`

> You may need to [install a C compiler](https://mesonbuild.com/SimpleStart.html#installing-a-compiler-toolchain)

Check that the libs from *requirements.txt* are installed
```
pip list
```

Build translations and database:
```
python scripts\compile_lang.py
python db_update.py
python PyfaDEV\scripts\compile_lang.py
python PyfaDEV\db_update.py
```

Test that the project is starting properly
Expand Down Expand Up @@ -88,6 +91,7 @@ Check that the project is starting properly.
Switch to the proper virtual environment
```
For cmd.exe: PyfaEnv\scripts\activate.bat
For PowerShell: PyfaEnv\Scripts\Activate.ps1
For bash: source <venv>/Scripts/activate
```

Expand Down