-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update CONTRIBUTING.md to explain cosmetics policy
Also adds a blurb about the missing code style guide.
- Loading branch information
Showing
1 changed file
with
19 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |