Skip to content

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

Merged

Conversation

LinjingZhang
Copy link
Collaborator

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

@LinjingZhang LinjingZhang requested review from jaenrig-ifx, ederjc and bargfred and removed request for jaenrig-ifx March 17, 2025 14:35
@LinjingZhang LinjingZhang marked this pull request as ready for review March 17, 2025 14:36
@LinjingZhang LinjingZhang force-pushed the DESMAKERS-4347-4350-development-instuctions-env-setup branch from b41e9af to 98bd101 Compare March 17, 2025 15:06
@jaenrig-ifx
Copy link
Member

jaenrig-ifx commented Mar 17, 2025

Can we generate the RTD branch to review?

@LinjingZhang LinjingZhang force-pushed the DESMAKERS-4347-4350-development-instuctions-env-setup branch from 5c077d3 to 0d49e1b Compare March 18, 2025 08:49
@LinjingZhang
Copy link
Collaborator Author

Can we generate the RTD branch to review?

I added a doc-preview branch.
@ederjc Can you generate rtd of this branch? Thanks!

@ederjc
Copy link
Member

ederjc commented Mar 18, 2025

Can we generate the RTD branch to review?

I added a doc-preview branch. @ederjc Can you generate rtd of this branch? Thanks!

here you go: https://xmc-arduino.readthedocs.io/en/doc-preview/

Copy link
Member

@jaenrig-ifx jaenrig-ifx left a 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which Python package? 😄

@LinjingZhang LinjingZhang merged commit a8cc43b into master Mar 20, 2025
18 checks passed
@LinjingZhang LinjingZhang deleted the DESMAKERS-4347-4350-development-instuctions-env-setup branch March 20, 2025 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants