Skip to content

Moved debugging tip from PR to contributor section #3159

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
merged 3 commits into from
May 8, 2025

Conversation

antimora
Copy link
Collaborator

@antimora antimora commented May 6, 2025

The tip on the PR makes the template busy. Most submitters do not need macro debugging. It's better if we live the tip in the contributor book section that we can refer people.

Pull Request Template

Related Issues/PRs

#3118

Changes

  1. Moved the tip from PR template to contributor section

Testing

Rendered

@antimora antimora requested a review from laggui May 6, 2025 16:15
Copy link
Member

@laggui laggui left a comment

Choose a reason for hiding this comment

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

The tip is already in the contributor book

https://github.com/tracel-ai/burn/blob/main/contributor-book/src/getting-started/setting-up-the-environment.md

As well as in the CONTRIBUTING.md (see linked PR #3118 which you reviewed).

The addition to the template was related to the suggestion in #3108 to add it by default.

I'm don't have a strong opinion on the addition or removal from the template. I think it's easy to ignore visually.

@antimora
Copy link
Collaborator Author

antimora commented May 6, 2025

The tip is already in the contributor book

https://github.com/tracel-ai/burn/blob/main/contributor-book/src/getting-started/setting-up-the-environment.md

As well as in the CONTRIBUTING.md (see linked PR #3118 which you reviewed).

The addition to the template was related to the suggestion in #3108 to add it by default.

I'm don't have a strong opinion on the addition or removal from the template. I think it's easy to ignore visually.

It's hard to ignore it =D Let's remove it.

Should I remove from the book, or leave it for troubleshooting so we can direct people?

@laggui
Copy link
Member

laggui commented May 8, 2025

Should I remove from the book, or leave it for troubleshooting so we can direct people?

Like I said, this is already in the book. So we can remove your addition to the book and link to the other section.

We can remove it from the PR template as you suggest though and refer people to this section. You're probably right that it is not useful to most people anyway.

@antimora antimora requested a review from laggui May 8, 2025 16:59
@laggui laggui merged commit 00b73c1 into tracel-ai:main May 8, 2025
Helios113 pushed a commit to Helios113/burn that referenced this pull request Jul 1, 2025
* Moved debugging tip to contributor section

* Removed from contributor book
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.

2 participants