-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
chore: List checks to be run prior to submitting a PR in CONTRIBUTING.md
#19118
Conversation
Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>
Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>
CONTRIBUTING.md
CONTRIBUTING.md
Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>
Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>
Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>
Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>
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.
I wonder if it would be reasonable to have a subcommand that wraps all of these so there would just be one thing to run.
It has been suggested, but the push back was that different people would have different sets of commands they want to run. However, if there is now a recommended set, it would seem to be more desirable. |
FWIW this is what we ended up doing for VRL:
|
…G.md` (vectordotdev#19118) * Add other CI jobs to CONTRIBUTING.md Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com> * Mention cargo fmt Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com> * Link to clippy Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com> * Make checks copy pasteable Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com> * Reduce line length Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com> * Remove urls Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com> --------- Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>
…G.md` (vectordotdev#19118) * Add other CI jobs to CONTRIBUTING.md Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com> * Mention cargo fmt Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com> * Link to clippy Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com> * Make checks copy pasteable Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com> * Reduce line length Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com> * Remove urls Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com> --------- Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>
I couldn't see this mentioned anywhere else. This adds a list of checks that should be run before submitting a PR to the
CONTRIBUTING.md
docs.