Skip to content

Commit

Permalink
Add contribution note for CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
koic committed Feb 16, 2023
1 parent 38a2ad0 commit 7af46ba
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 3 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Change log

<!---
Do NOT edit this CHANGELOG.md file by hand directly, as it is automatically updated.
Please add an entry file to the https://github.com/rubocop/rubocop-rails/blob/master/changelog/
named `{change_type}_{change_description}.md` if the new code introduces user-observable changes.
See https://github.com/rubocop/rubocop-rails/blob/master/CONTRIBUTING.md#changelog-entry-format for details.
-->

## master (unreleased)

## 2.17.4 (2022-12-25)
Expand Down
Empty file added changelog/.gitkeep
Empty file.
4 changes: 2 additions & 2 deletions spec/project_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,8 @@
expect(changelog.end_with?("\n")).to be true
end

it 'has either entries, headers, or empty lines' do
expect(non_reference_lines).to all(match(/^(\*|#|$)/))
it 'has either entries, headers, empty lines, or comments' do
expect(non_reference_lines).to all(match(/^(\*|#|$|<!---|-->| )/))
end

describe 'entry' do
Expand Down
1 change: 0 additions & 1 deletion tasks/changelog.rb
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ def initialize(type:, body: last_commit_title, ref_type: nil, ref_id: nil, user:
end

def write
FileUtils.mkdir_p(ENTRIES_PATH)
File.write(path, content)
path
end
Expand Down

0 comments on commit 7af46ba

Please sign in to comment.