New board contribution guidelines ?

[martinroger]

Hi @Lzw655 , I thought I remembered there being some guidelines (linting, which files to edit, etc...) for contributing new screen configurations to the repository. Unfortunately I cannot seem to find them in the documentation, do you still have a rough process I can follow ?

[Lzw655]

Hi @martinroger,

Sorry for the late. You're right. The previous v0 version did have such a guidance document. However, the file structure of v1 has changed, and the previous documents are no longer applicable. Therefore, I have temporarily removed them and will add them back later.

At present, you can refer to the modifications in a similar commit to add a new development board. BTW, you only need the esp_panel_board_supported_conf.h file in the root directory, because running pre-commit will automatically modify other files with the same name. Thank you very much for your contribution!

[martinroger]

Ok, I went and added forced encoding everywhere I could, but I'm still running in a couple issues :

> git -c user.useConfigOnly=true commit --quiet
astyle formatter.........................................................Passed
Check copyright notices..................................................Passed
flake8...................................................................Passed
trim trailing whitespace.................................................Passed
fix end of files.........................................................Passed
check that executables have shebangs.....................................Passed
check that scripts with shebangs are executable..........................Passed
mixed line ending........................................................Passed
fix double quoted strings................................................Passed
Do not use more than one slash in the branch name........................Failed
- hook id: no-commit-to-branch
- exit code: 1
Do not use uppercase letters in the branch name..........................Failed
- hook id: no-commit-to-branch
- exit code: 1
codespell................................................................Passed
Check File Permissions...................................................Failed
- hook id: check-executables
- exit code: 1

"tools/check_file_version.py" is not executable but is in C:\Users\Martin\Documents\GitHub\ESP32_Display_Panel\tools/executable-list.txt
"tools/sync_conf_files.py" is not executable but is in C:\Users\Martin\Documents\GitHub\ESP32_Display_Panel\tools/executable-list.txt

Validate executable-list.txt.............................................Passed
Update when configuration files change...................................Passed
Update when template files change....................(no files to check)Skipped
Update when versions change..............................................Passed
Check library versions...................................................Failed
- hook id: check-library-versions
- exit code: 1

Executable `/bin/bash` not found

• my current branch name is master so I am not entirely sure how I am failing that check
• not sure about the executable files permissions, I guess there might be a chmod +x needed on those ?
• Library versions : I pre-empted and set both the Arduino library version and the .h file to v1.0.4 for the main library version, but I guess I might have misunderstood ?
• /bin/bash not found : I'm on Windows 11 with the WSL installed, but I guess I need to go faff around with the PATH to make sure bash is somehow found. I'll try to solve that one myself if you don't have an easy fix.

Almost there !

UPDATE : I think I found a way around all of this. PR incoming ! (and thank God we have Raspberry Pi)

[Lzw655]

Hi @martinroger,

You did an excellent job!

1. Usually, we don't directly make modifications on the master branch. Instead, we create a new branch based on the master and submit a PR with this branch.
2. Yes, you're right. These two files should have the executable attribute. However, no error was reported on Ubuntu. I will fix this issue.
3. I think you already know what the problem is.
4. I really haven't encountered this before. Can you try deleting #!/bin/bash in tools/check_lib_versions.sh?

[martinroger]

Hi @martinroger,

You did an excellent job!

1. Usually, we don't directly make modifications on the master branch. Instead, we create a new branch based on the master and submit a PR with this branch.

Crap, you are right! I completely forgot to branch and PR in my own fork, the heat here must be melting my brain.

2. Yes, you're right. These two files should have the executable attribute. However, no error was reported on Ubuntu. I will fix this issue.
3. I think you already know what the problem is.
4. I really haven't encountered this before. Can you try deleting #!/bin/bash in tools/check_lib_versions.sh?

Will do and report here.

[martinroger]

Hi @Lzw655 ,

4. I really haven't encountered this before. Can you try deleting #!/bin/bash in tools/check_lib_versions.sh?

Poor PowerShell really didn't like it, I'm still looking into how to make bash as natively available as possible in Win11 but so far I didn't find something simple. I guess for now it means that pre-commit checks are more possible under Linux of MacOs...

[Lzw655]

Hi @Lzw655 ,

4. I really haven't encountered this before. Can you try deleting #!/bin/bash in tools/check_lib_versions.sh?

Poor PowerShell really didn't like it, I'm still looking into how to make bash as natively available as possible in Win11 but so far I didn't find something simple. I guess for now it means that pre-commit checks are more possible under Linux of MacOs...

Yes, I always use Ubuntu for development, and the compilation speed under Win11 is really unbearable.