-
Notifications
You must be signed in to change notification settings - Fork 14
chore: Ruby 3.3+ floor, modern GHA, gemspec hygiene #755
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
d31e2c6
chore: Ruby 3.3+ floor, modern GHA, gemspec hygiene
ronaldtse e3f8cef
docs: add SECURITY.md
ronaldtse cdc668f
chore: adopt StandardRB for lib/ + auto-fix 953 violations
ronaldtse 2cf29c3
docs: add CONTRIBUTING.md
ronaldtse 62068f3
docs: add CI badge
ronaldtse 5851c22
docs: add CHANGELOG.md
ronaldtse 60b7b4e
ci: add CodeQL workflow for Ruby
ronaldtse File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: github-actions | ||
| directory: "/" | ||
| schedule: | ||
| interval: weekly | ||
| - package-ecosystem: bundler | ||
| directory: "/" | ||
| schedule: | ||
| interval: weekly |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| name: codeql | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| schedule: | ||
| - cron: "0 0 * * 0" # weekly | ||
|
|
||
| permissions: | ||
| actions: read | ||
| contents: read | ||
| security-events: write | ||
|
|
||
| jobs: | ||
| analyze: | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| language: [ruby] | ||
| steps: | ||
| - uses: actions/checkout@v7 | ||
| - uses: github/codeql-action/init@v3 | ||
| with: | ||
| languages: ${{ matrix.language }} | ||
| - uses: github/codeql-action/analyze@v3 |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # StandardRB config — enforce Ruby style on lib/, leave specs/bin/exe flexible for now. | ||
| # Existing violations in lib/ were auto-fixed in this PR; remaining violations are | ||
| # tracked in TODO.complete/06-standardrb-ruby-gems.md. | ||
| ignore: | ||
| - "bin/**/*" | ||
| - "exe/**/*" | ||
| - "spec/**/*" | ||
| - "docs/**/*" | ||
| - "reference-docs/**/*" | ||
| - "pkg/**/*" | ||
| - "vendor/**/*" |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Changelog | ||
|
|
||
| All notable changes to this project are documented in this file. | ||
|
|
||
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), | ||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ## [Latest] | ||
|
|
||
| See GitHub releases for detailed release notes: https://github.com/interscript/interscript-ruby/releases |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # Contributing | ||
|
|
||
| Thanks for your interest in contributing! | ||
|
|
||
| ## Development setup | ||
|
|
||
| ```bash | ||
| git clone <this repo> | ||
| cd <repo> | ||
| bundle install # Ruby projects | ||
| # or | ||
| npm ci # JS projects | ||
| ``` | ||
|
|
||
| ## Workflow | ||
|
|
||
| 1. Fork → branch from `main` | ||
| 2. Make changes with tests | ||
| 3. Run `bundle exec rspec` (Ruby) or `npm test` (JS) locally | ||
| 4. Run `bundle exec standardrb` (Ruby) or `npm run lint` (JS) | ||
| 5. Open a PR with a clear description | ||
|
|
||
| ## Code style | ||
|
|
||
| - Ruby: enforced by [StandardRB](https://github.com/standardrb/standard) | ||
| - JavaScript: enforced by ESLint + Prettier | ||
| - Python: enforced by ruff | ||
|
|
||
| ## Commit messages | ||
|
|
||
| Use [Conventional Commits](https://www.conventionalcommits.org/): | ||
|
|
||
| ``` | ||
| feat: add new transliteration system | ||
| fix: correct off-by-one in CALT lookup | ||
| chore: bump dependencies | ||
| docs: clarify README | ||
| ``` | ||
|
|
||
| ## Releases | ||
|
|
||
| Maintainers tag releases following semver. CI publishes on tag push. |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.