From a5a505eafd8c7e40bae6eb42aa08b5a0eff9b70b Mon Sep 17 00:00:00 2001 From: James Kessler Date: Thu, 20 Nov 2025 14:27:47 -0800 Subject: [PATCH 1/2] Update README with new sections and information Added sections for Open-Source Promise, Getting Help, Contributing, License, and Code of Conduct. --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8b03088d..07beddb9 100644 --- a/README.md +++ b/README.md @@ -161,6 +161,24 @@ github-token: ${{ secrets.GITHUB_TOKEN }} --- -## [MIT License](LICENSE.md) +## Our Open-Source Promise -## [Contributing](CONTRIBUTING.md) +Coveralls.io is always free for open-source projects. Create a [free account](https://coveralls.io/pricing) for your (public) repo at Coveralls, then use one of our [official integrations](https://docs.coveralls.io/integrations#official-integrations): [coverage-reporter](https://github.com/coverallsapp/coverage-reporter), [github-action](https://github.com/coverallsapp/github-action), or [orb](https://github.com/coverallsapp/orb) to upload coverage to the [Coveralls API](https://docs.coveralls.io/api-introduction). + +Additionally, over 30 [community-created language integrations](https://docs.coveralls.io/integrations#language-integrations) exist for coveralls, which you can find a list of [here](https://docs.coveralls.io/integrations#language-integrations). + +## Getting help + +Issues? Questions? Reach out to us [here](https://github.com/coverallsapp/coverage-reporter/issues), or at support@coveralls.io. + +## Contributing + +[Bug reports](https://github.com/coverallsapp/coverage-reporter/issues) and [pull requests](https://github.com/coverallsapp/coverage-reporter/pulls) are welcome. + +## License + +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). + +## Code of Conduct + +Contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. From ba6dae83310bbd6d33ff77092650dc40bd444a2a Mon Sep 17 00:00:00 2001 From: James Kessler Date: Thu, 20 Nov 2025 14:36:35 -0800 Subject: [PATCH 2/2] Revise README for clarity on integrations and support Updated README to clarify open-source offerings and integration options. --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 07beddb9..80a699c5 100644 --- a/README.md +++ b/README.md @@ -163,17 +163,21 @@ github-token: ${{ secrets.GITHUB_TOKEN }} ## Our Open-Source Promise -Coveralls.io is always free for open-source projects. Create a [free account](https://coveralls.io/pricing) for your (public) repo at Coveralls, then use one of our [official integrations](https://docs.coveralls.io/integrations#official-integrations): [coverage-reporter](https://github.com/coverallsapp/coverage-reporter), [github-action](https://github.com/coverallsapp/github-action), or [orb](https://github.com/coverallsapp/orb) to upload coverage to the [Coveralls API](https://docs.coveralls.io/api-introduction). +Coveralls.io is always free for open-source projects! -Additionally, over 30 [community-created language integrations](https://docs.coveralls.io/integrations#language-integrations) exist for coveralls, which you can find a list of [here](https://docs.coveralls.io/integrations#language-integrations). +Create a [free account](https://coveralls.io/pricing) for your (public) repo at Coveralls, then use one of our [official integrations](https://docs.coveralls.io/integrations#official-integrations)—[coverage-reporter](https://github.com/coverallsapp/coverage-reporter), [github-action](https://github.com/coverallsapp/github-action) (this project!), or [orb](https://github.com/coverallsapp/orb)—to upload your coverage reports to the [Coveralls API](https://docs.coveralls.io/api-introduction). + +Additionally, over 30 [community-created language integrations](https://docs.coveralls.io/integrations#language-integrations) exist for Coveralls.io, which you can find [here](https://docs.coveralls.io/integrations#language-integrations). ## Getting help -Issues? Questions? Reach out to us [here](https://github.com/coverallsapp/coverage-reporter/issues), or at support@coveralls.io. +[Get started](https://docs.coveralls.io/) with our [documentation here](https://docs.coveralls.io/). + +Issues or Questions? Reach out to us [here](https://github.com/coverallsapp/github-action/issues), or at support@coveralls.io. ## Contributing -[Bug reports](https://github.com/coverallsapp/coverage-reporter/issues) and [pull requests](https://github.com/coverallsapp/coverage-reporter/pulls) are welcome. +[Bug reports](https://github.com/coverallsapp/github-action/issues) and [pull requests](https://github.com/coverallsapp/github-action/pulls) are welcome. ## License