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

chore: List checks to be run prior to submitting a PR in CONTRIBUTING.md #19118

Merged
merged 6 commits into from
Nov 10, 2023

Conversation

StephenWakely
Copy link
Contributor

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.

Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>
Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>
@StephenWakely StephenWakely changed the title chore: Add other CI jobs to CONTRIBUTING.md chore: List checks to be run prior to submitting a PR in CONTRIBUTING.md Nov 10, 2023
CONTRIBUTING.md Outdated Show resolved Hide resolved
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>
Copy link
Member

@jszwedko jszwedko left a 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.

@bruceg
Copy link
Member

bruceg commented Nov 10, 2023

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.

@pront
Copy link
Member

pront commented Nov 10, 2023

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:

@StephenWakely StephenWakely added this pull request to the merge queue Nov 10, 2023
Merged via the queue into master with commit b0c09e1 Nov 10, 2023
40 checks passed
@StephenWakely StephenWakely deleted the stephen/checks_docs branch November 10, 2023 19:01
pront pushed a commit to dygfloyd/vector that referenced this pull request Nov 15, 2023
…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>
AndrooTheChen pushed a commit to discord/vector that referenced this pull request Sep 23, 2024
…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>
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.

4 participants