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: document how flags can be toggled in tests #122

Merged
merged 6 commits into from Mar 19, 2024

Conversation

dimaqq
Copy link
Contributor

@dimaqq dimaqq commented Feb 2, 2024

Document how flags can be toggled in tests
#121

@dimaqq
Copy link
Contributor Author

dimaqq commented Feb 2, 2024

@willbarton I think a maintainer needs to do something for GHA to run 🙇🏻

Copy link
Member

@willbarton willbarton left a comment

Choose a reason for hiding this comment

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

Thanks, @dimaqq!

How would you feel about simplifying the language and structure a bit and adding this to usage.md instead of its of own file? I think this is important to call out as general usage, because folks should be writing tests! I have another suggestion about to simplify it below.

If you don't want to put this in usage.md, then the new file will need to be added to mkdocs.yml to appear in the documentation.

docs/testing.md Outdated Show resolved Hide resolved
Co-authored-by: Will Barton <will@brtns.com>
@dimaqq
Copy link
Contributor Author

dimaqq commented Feb 5, 2024

Makes sense, I've committed your suggestion.

@dimaqq
Copy link
Contributor Author

dimaqq commented Feb 5, 2024

Re: usage, I guess the first block, the simple case could be moved to usage 🤔
Edit: done.

docs/testing.md Show resolved Hide resolved
docs/usage.md Show resolved Hide resolved
dimaqq and others added 2 commits February 29, 2024 09:48
Co-authored-by: Will Barton <will@brtns.com>
Co-authored-by: Will Barton <will@brtns.com>
@dimaqq
Copy link
Contributor Author

dimaqq commented Feb 29, 2024

suggestions have been added, thank you :)

@dimaqq
Copy link
Contributor Author

dimaqq commented Mar 19, 2024

@willbarton wdyt, is it mergeable now?
It seems that only maintainers can merge PRs in this repo, I certainly am not allowed to.

@willbarton
Copy link
Member

@dimaqq Correct, only maintainers can merge PRs. That's kind of basic PR security ;)

Yes, it looks good. I'll get it merged!

@willbarton willbarton merged commit 5972084 into cfpb:main Mar 19, 2024
9 checks passed
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.

None yet

2 participants