[oss][fboss] Introduce FBOSS github pull request template #617
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.
Pre-submission checklist
pip install -r requirements-dev.txt && pre-commit installpre-commit runSummary
This PR will introduce a new FBOSS github pull request template which shows the pre-submission checklist, and the two basic sessions that Meta internal diff format: Summary and Test Plan
I also integrated pre-commit in this diff to allow clang formatting which is using the .clang-format in our fboss directory.
Once a user run
pre-commit runonce, it will automatically create a hook and will trigger the pre-commit automatically every time when they rungit commit.TODO: In the future, I'll introduce clang-linter in the pre-commit so users can correct any linter error before commit
Test Plan
Unfortunately, I can't verify whether my
.github/pull_request_template.mdworks in this diff when I was composing my PR description, because it only works in the default branch and my PR has to use a local branch.But I did verify my pre-commit work by manually messed up with one file to violate the clang-format rule.
You can see when I try to amend my commit, now the file was modified to the right format