Skip to content

Commit

Permalink
Feat/docs (#3)
Browse files Browse the repository at this point in the history
* 📝 Add Tidelift contact to SECURITY.md

* 🩹 Project name

* 📝 Documentation
  • Loading branch information
pboling authored Feb 23, 2025
1 parent df8efa6 commit 84c4fab
Show file tree
Hide file tree
Showing 6 changed files with 327 additions and 77 deletions.
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ open_collective: # Replace with a single Open Collective username
patreon: galtzo # Replace with a single Patreon username
polar: pboling
thanks_dev: u/gh/pboling
tidelift: rubygems/omniauth-identity # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
tidelift: rubygems/gem_checksums # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
23 changes: 17 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
# Changelog

All notable changes to this project since v2.0 will be documented in this file.
[![SemVer 2.0.0][📌semver-img]][📌semver] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog]

The format is based on [Keep a Changelog v1](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.0.0.html).
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog][📗keep-changelog],
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
and [yes][📌major-versions-not-sacred], platform and engine support are part of the [public API][📌semver-breaking].
Please file a bug if you notice a violation of semantic versioning.

[📌semver]: https://semver.org/spec/v2.0.0.html
[📌semver-img]: https://img.shields.io/badge/semver-2.0.0-FFDD67.svg?style=flat
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat

## [Unreleased]
### Added
Expand All @@ -12,9 +23,9 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
### Removed

## [1.0.0] - 2025-01-23 ([tag][1.0.0t])
- COVERAGE: 37.50% -- 18/48 lines in 3 files
- BRANCH COVERAGE: 10.00% -- 1/10 branches in 3 files
- 28.57% documented
- Line Coverage: 60.34% (35 / 58)
- Branch Coverage: 50.0% (6 / 12)
- 55.56% documented
### Added
- Initial release

Expand Down
5 changes: 4 additions & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

# Contributor Covenant Code of Conduct

## Our Pledge
Expand Down Expand Up @@ -60,7 +61,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[INSERT CONTACT METHOD].
[![Contact BDFL][🚂bdfl-contact-img]][🚂bdfl-contact].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down Expand Up @@ -130,3 +131,5 @@ For answers to common questions about this code of conduct, see the FAQ at
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
[🚂bdfl-contact]: http://www.railsbling.com/contact
[🚂bdfl-contact-img]: https://img.shields.io/badge/Contact-BDFL-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
2 changes: 0 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,8 @@ See: [RubyGems Security Guide][🔒️rubygems-security-guide]
12. Run `bundle exec rake release` which will create a git tag for the version,
push git commits and tags, and push the `.gem` file to [rubygems.org][💎rubygems]

[⛳mail-list]: http://groups.google.com/group/oauth-ruby
[🚎src-main]: https://gitlab.com/pboling/gem_checksums
[🧪build]: https://github.com/pboling/gem_checksums/actions
[🏘chat]: https://matrix.to/#/#pboling_version_gem:gitter.im
[🤝conduct]: https://gitlab.com/pboling/gem_checksums/-/blob/main/CODE_OF_CONDUCT.md
[🖐contrib-rocks]: https://contrib.rocks
[🖐contributors]: https://github.com/pboling/gem_checksums/graphs/contributors
Expand Down
Loading

0 comments on commit 84c4fab

Please sign in to comment.