mention code formatting in contribution guidelines #5514
Merged
Conversation
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
csyonghe
reviewed
Nov 7, 2024
| /* end */ | ||
| ``` | ||
| If you open a pull request and the formatting is incorrect, you can comment | ||
| `/format` and a bot will format your code for you. |
There was a problem hiding this comment.
We should explain that a PR will be created and you need to merge that PR.
|
Is there a way to run the formatting my local machine? I personally prefer to get is done before presenting it to others as a review. |
jkwak-work
reviewed
Nov 8, 2024
|
|
||
| Open a pull request against `shader-slang/slang`. | ||
|
|
||
| Code formatting can be automatically fixed on your branch by commenting `/format`, a bot will proceed to open a PR targeting *your* branch. |
There was a problem hiding this comment.
The formatting is a required process not an optional step. I think we should describe that the generated PR needs to be merged here as Yong pointed out on the other spot.
|
@jkwak-work You can configure VisualStudio or VSCode to perform formatting on save. In visual studio it is called Code Cleanup: You also need to set code formatter to clang-format. Once configured, you will never need to worry about formatting any more. |
csyonghe
approved these changes
Nov 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #5511