docs: Fix contributing.md#2923
Merged
pplantinga merged 1 commit intospeechbrain:developfrom May 22, 2025
Merged
Conversation
pplantinga
pushed a commit
to pplantinga/speechbrain
that referenced
this pull request
Jun 2, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What does this PR do?
This PR updates the CONTRIBUTING.md to correctly use
git push -u origin your-branch-nameand adds a short explanation for the -u flag. This makes the contribution steps more clearer for new users.Your documentation is incredibly clear and well-structured—it made it very easy for me to get started with the library today. I noticed this minor issue while going through the contribution steps and felt it was worth pointing out to keep things as polished as they already are.
Thanks for maintaining such a clean and thoughtfully designed open-source project!
Also, I’m fascinated by HyperPyYAML—I might even use it in my research project :)
Before submitting
PR review
Reviewer checklist