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 43a5428 commit 753face
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 3 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# 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-minitest/blob/master/changelog/
named `{change_type}_{change_description}.md` if the new code introduces user-observable changes.
See https://github.com/rubocop/rubocop-minitest/blob/master/CONTRIBUTING.md#changelog-entry-format for details.
-->

## master (unreleased)

## 0.27.0 (2023-01-30)
Expand Down
Empty file added changelog/.gitkeep
Empty file.
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
4 changes: 2 additions & 2 deletions test/project_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ def test_changelog_has_newline_at_end_of_file
assert(@changelog.end_with?("\n"))
end

def test_changelog_has_either_entries_headers_or_empty_lines
def test_changelog_has_either_entries_headers_empty_lines_or_comments
non_reference_lines = @lines.take_while { |line| !line.start_with?('[@') }

non_reference_lines.each do |line|
assert_match(/^(\*|#|$)/, line)
assert_match(/^(\*|#|$|<!---|-->| )/, line)
end
end

Expand Down

0 comments on commit 753face

Please sign in to comment.