Skip to content
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

MAINT: Add a warning not to modify auto-generated files #2332

Conversation

david-cortes-intel
Copy link
Contributor

Description

This PR adds a warning note on auto-generated makefiles to not modify them manually. It also removes the copyright headers from them since they are auto-generated.


PR should start as a draft, then move to ready for review state after CI is passed and all applicable checkboxes are closed.
This approach ensures that reviewers don't spend extra time asking for regular requirements.

You can remove a checkbox as not applicable only if it doesn't relate to this PR in any way.
For example, PR with docs update doesn't require checkboxes for performance while PR with any change in actual code should have checkboxes and justify how this code change is expected to affect performance (or justification should be self-evident).

Checklist to comply with before moving PR from draft:

PR completeness and readability

  • I have reviewed my changes thoroughly before submitting this pull request.
  • I have commented my code, particularly in hard-to-understand areas.
  • Git commit message contains an appropriate signed-off-by string (see CONTRIBUTING.md for details).
  • I have added a respective label(s) to PR if I have a permission for that.
  • I have resolved any merge conflicts that might occur with the base branch.

Testing

Not applicable.

Performance

Not applicable.

Copy link

codecov bot commented Feb 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Flag Coverage Δ
azure 78.05% <ø> (ø)
github 70.74% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Copy link
Contributor

@icfaust icfaust left a comment

Choose a reason for hiding this comment

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

If they are auto-generated, should we remove them and add them to .gitignore? Otherwise the PR is straightforward.

@david-cortes-intel
Copy link
Contributor Author

If they are auto-generated, should we remove them and add them to .gitignore? Otherwise the PR is straightforward.

I'd say no, because they are generated by a command that is not triggered by the docs build (sphinx-quickstart, not sure if this comes from the regular Sphinx package), which has lots of options for how to trigger it that have effects on the resulting file.

@david-cortes-intel david-cortes-intel merged commit 9e7b82b into uxlfoundation:main Mar 5, 2025
25 of 27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants