-
Notifications
You must be signed in to change notification settings - Fork 72
Desmakers 4347 4350 development instuctions env setup #330
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Desmakers 4347 4350 development instuctions env setup #330
Conversation
b41e9af
to
98bd101
Compare
Can we generate the RTD branch to review? |
Signed-off-by: zhanglinjing <[email protected]>
Signed-off-by: zhanglinjing <[email protected]>
Signed-off-by: zhanglinjing <[email protected]>
Signed-off-by: zhanglinjing <[email protected]>
Signed-off-by: Eder Julian <[email protected]>
Signed-off-by: zhanglinjing <[email protected]>
Signed-off-by: zhanglinjing <[email protected]>
5c077d3
to
0d49e1b
Compare
I added a doc-preview branch. |
here you go: https://xmc-arduino.readthedocs.io/en/doc-preview/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All good!
At some point some of these can be links to the reusable devops repo projects where the documentation should allow to add these to any new core.
For the C/C++ code format and commit message format, we add git hooks to check it automatically. | ||
|
||
For ease of use, we currently use `pre-commit <https://pre-commit.com/>`_ to automatically run clang-formatting to format all C/C++ code. | ||
Please install this Python package, and follow the quick start (the pre-commit configuration file is already there). You should be able to format your code automatically on git commit. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Which Python package? 😄
By creating this pull request you agree to the terms in CONTRIBUTING.md.
https://github.com/Infineon/.github/blob/master/CONTRIBUTING.md
--- DO NOT DELETE ANYTHING ABOVE THIS LINE ---
CONTRIBUTING.md also tells you what to expect in the PR process.
Description
Adding development instructions in documentation.
should be sufficient for contributor working on windows/linux
Related Issue
Desmakers 4347/4350
Context