mirrors/quickpassthrough
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add Contributing section

Browse source 
Added contributing section
This commit is contained in:
HikariKnight 2022-02-28 19:45:55 +01:00 • committed by GitHub
parent 0127f0bc86
commit 193af1650d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -19,6 +19,16 @@ chmod +x ./vfio-setup
* Enable and configure the correct kernel modules
* Provides you with the correct kernel arguments to add to your bootloader entry
## Contributing
<img src="https://user-images.githubusercontent.com/2557889/156038229-4e70352f-9182-4474-8e32-d14d3ad67566.png" width="250px"><br>
I know my bash skills are not great, so help is always welcome! And help is wanted here.<br>
If you know bash well, you will be able to help! Just make a pull request with your changes!<br>
Just remember to add comments to document the work and explain it for people who are less familiar with the bash syntax or anything else you use. 😄<br>
<br>
Also if you know english, you can just help proof reading. English is not my native language, plus I have dyslexia so I often make spelling mistakes.<br>
Proof reading is still contribution!
## TODO
* ~~Everything~~
* ~~Show general warning to user and inform about making a backup and general expectations~~
@ -39,4 +49,4 @@ chmod +x ./vfio-setup
### Why bash?
I wanted the dependencies to be minimal without the need for compilation and not have a potential breaking change in the future (like with the transition from python2 to python3).
I know enough bash to make things work, but I am in no way a professional in writing bash scripts as I usually write python and golang.
I know enough bash to make things work, but I am in no way a professional in writing bash scripts as I usually write python and golang.