mirrors/nvidia-open-gpu-kernel-modules
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update CONTRIBUTING.md to explain cosmetics policy

Browse Source 
Also adds a blurb about the missing code style guide.
This commit is contained in:
Bernhard Stoeckner 2022-07-07 11:02:42 +02:00
parent 94eaea9726
commit 88636e701d
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
CONTRIBUTING.md
View File

@ -1,3 +1,21 @@
Thank you for all the enthusiasm around open-gpu-kernel-modules.
For the next while, we are going to focus review on pull requests of functional changes. Please refrain from further cosmetic pull requests until we publish our style guide.
## Non-functional (cosmetic) changes
While we appreciate your enthusiasm, we have decided not to accept non-functional changes such as
non-code typo fixes, comment and language adjustments, whitespace changes, and similar.
Changes going into this codebase incur significant overhead. As such, we want to focus our resources
on executable code improvements for now.
If you have questions, or are unsure about the nature of your desired change, please ask us on the
[Discussion boards](https://github.com/NVIDIA/open-gpu-kernel-modules/discussions)!
## Code style
We currently do not publish a code style guide, as we have many different components coming together.
Please read the existing code in the repository, especially the one surrounding your proposed change,
to get a feel for what you should aim for.
Don't worry too much about it! We are happy to guide you through any neccessary style changes through
code review of your PR.