Skip to content

Commit a5a505e

Browse files
authored
Update README with new sections and information
Added sections for Open-Source Promise, Getting Help, Contributing, License, and Code of Conduct.
1 parent 5cbfd81 commit a5a505e

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,24 @@ github-token: ${{ secrets.GITHUB_TOKEN }}
161161

162162
---
163163

164-
## [MIT License](LICENSE.md)
164+
## Our Open-Source Promise
165165

166-
## [Contributing](CONTRIBUTING.md)
166+
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).
167+
168+
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).
169+
170+
## Getting help
171+
172+
Issues? Questions? Reach out to us [here](https://github.com/coverallsapp/coverage-reporter/issues), or at [email protected].
173+
174+
## Contributing
175+
176+
[Bug reports](https://github.com/coverallsapp/coverage-reporter/issues) and [pull requests](https://github.com/coverallsapp/coverage-reporter/pulls) are welcome.
177+
178+
## License
179+
180+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
181+
182+
## Code of Conduct
183+
184+
Contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

0 commit comments

Comments
 (0)