Skip to content

Commit

Permalink
Update changelog for PR #167
Browse files Browse the repository at this point in the history
  • Loading branch information
halostatue committed Jul 4, 2022
1 parent 071107b commit da5d341
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 11 deletions.
21 changes: 10 additions & 11 deletions Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ request, or code contributions.
There are a few guidelines for contributing to mime-types:

- Code changes _will_ _not_ be accepted without tests. The test suite is
written with [minitest].
written with [minitest][].
- Match my coding style.
- Use a thoughtfully-named topic branch that contains your change. Rebase your
commits into logical chunks as necessary.
- Use [quality commit messages].
- Use [quality commit messages][].
- Do not change the version number; when your patch is accepted and a release
is made, the version will be updated at that point.
- Submit a GitHub pull request with your changes.
Expand All @@ -19,25 +19,23 @@ There are a few guidelines for contributing to mime-types:
## Adding or Modifying MIME Types

The mime-types registry is no longer contained in mime-types, but in
[mime-types-data]. Please see that project for contributions there.
[mime-types-data][]. Please see that project for contributions there.

### Test Dependencies

mime-types uses Ryan Davis’s [Hoe] to manage the release process, and it adds
a number of rake tasks. You will mostly be interested in `rake`, which runs
the tests the same way that `rake test` or `rake travis` will do.
mime-types uses Ryan Davis’s [Hoe][] to manage the release process, and it adds
a number of rake tasks. You will mostly be interested in `rake`, which runs the
tests the same way that `rake test` or `rake travis` will do.

To assist with the installation of the development dependencies for
mime-types, I have provided the simplest possible Gemfile pointing to the
(generated) `mime-types.gemspec` file. This will permit you to do `bundle
install` to get the development dependencies. If you aleady have `hoe`
(generated) `mime-types.gemspec` file. This will permit you to do `bundle install` to get the development dependencies. If you aleady have `hoe`
installed, you can accomplish the same thing with `rake newb`.

This task will install any missing dependencies, run the tests/specs, and
generate the RDoc.

You can run tests with code coverage analysis by running `rake
test:coverage`.
You can run tests with code coverage analysis by running `rake test:coverage`.

## Benchmarks

Expand All @@ -52,7 +50,7 @@ built-in benchmark library:

There are two allocation tracing benchmarks (for normal and columnar loads).
These can only be run on Ruby 2.1 or better and requires the
[allocation\_tracer] gem (not installed by default).
[allocation\_tracer][] gem (not installed by default).

- `rake benchmark:allocations`
- `rake benchmark:allocations:columnar`
Expand Down Expand Up @@ -84,6 +82,7 @@ Here's the most direct way to get your work merged into the project:
Thanks to everyone else who has contributed to mime-types over the years:

- Aaron Patterson
- Alex Vondrak
- Aggelos Avgerinos
- Al Snow
- Andre Pankratz
Expand Down
9 changes: 9 additions & 0 deletions History.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Changelog

## NEXT / 2022-MM-DD

- 1 bugfix:

- Added a definition of `MIME::Type#hash`. Contributed by Alex Vondrak in
[#167][], fixing [#166][].

## 3.4.1 / 2021-11-16

- 1 bugfix:
Expand Down Expand Up @@ -264,6 +271,8 @@
[#149]: https://github.com/mime-types/ruby-mime-types/pull/149
[#150]: https://github.com/mime-types/ruby-mime-types/pull/150
[#153]: https://github.com/mime-types/ruby-mime-types/pull/153
[#166]: https://github.com/mime-types/ruby-mime-types/issues/166
[#167]: https://github.com/mime-types/ruby-mime-types/pull/167
[code-of-conduct.md]: Code-of-Conduct_md.html
[contributor covenant]: http://contributor-covenant.org
[mime-types-data]: https://github.com/mime-types/mime-types-data

0 comments on commit da5d341

Please sign in to comment.