update: README.md and CONTRIBUTING.md #149
Open
+70
−27
Conversation
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
Signed-off-by: Melissa Kilby <[email protected]>
heckj
reviewed
Oct 6, 2025
|
|
||
| When you create a bug report, please provide the following: | ||
|
|
||
| - **swift-prometheus commit hash** you are using. |
There was a problem hiding this comment.
All great detail, and we should include a PR template that specifically asks for this detail as well
| ``` | ||
|
|
||
| - **Simulate CI Workflows (Optional)**: For a more comprehensive check, you can run the full GitHub Actions workflows locally using [act](https://github.com/nektos/act). This is useful for catching issues that only appear in the CI environment. | ||
| - For detailed setup instructions, see the Swift project's guide on [Running Workflows Locally](https://github.com/swiftlang/github-workflows?tab=readme-ov-file#running-workflows-locally). |
There was a problem hiding this comment.
I tried the whole sequence with act and really struggled to get it working with anything OTHER than docker-desktop - I love the concept of describing this and providing a means to check the workflows locally, but it was particularly cranky for me.
I'm not immediately clear on what other options there might be, or how to make that process work a bit more smoothly - say for example, using container instead of docker and what might need to exist to arrange that. That's probably beyond the scope of this edit though.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
update: README.md and CONTRIBUTING.md
Fixes #148
CC @ktoso @heckj