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

docs: update CONTRIBUTING.md #25837

Merged
merged 1 commit into from
Jan 15, 2025
Merged

docs: update CONTRIBUTING.md #25837

merged 1 commit into from
Jan 15, 2025

Conversation

hiltontj
Copy link
Contributor

No issue for this.

I noticed some things in our CONTRIBUTING.md that could be updated, namely:

  • update docs on how to run tests
  • remove references to docs/ pages that are in IOx, but not this repo


```shell
TEST_LOG= cargo nextest run -p influxdb3 --nocapture
Copy link
Contributor

Choose a reason for hiding this comment

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

is it worth calling TEST_LOG out in the section above that lays out the cargo command to run normal test as well?

Copy link
Contributor

@praveen-influx praveen-influx left a comment

Choose a reason for hiding this comment

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

Looks good - just a minor suggestion.

@hiltontj hiltontj requested a review from a team January 15, 2025 14:43
@hiltontj hiltontj force-pushed the hiltontj/contributing branch 2 times, most recently from 70e1c87 to 735f1cc Compare January 15, 2025 14:59
@hiltontj hiltontj force-pushed the hiltontj/contributing branch from 735f1cc to 3850269 Compare January 15, 2025 15:01
@hiltontj
Copy link
Contributor Author

Okay, I think I got it now, updated the tests with logging section to use TEST_LOG up front.

@hiltontj hiltontj merged commit 256da6e into main Jan 15, 2025
13 checks passed
@hiltontj hiltontj deleted the hiltontj/contributing branch January 15, 2025 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants