lynndylanhurley / lynndylanhurley/devise_token_auth

Change logs with more meaningful information

Open
#1,653 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
3.6k
Forks
1.1k
PR merge metrics
No merged PRs in 30d

Description

This [repository Changelog](https://github.com/lynndylanhurley/devise_token_auth/blob/master/CHANGELOG.md) only contains "Closed issues" and "Merged pull requests".

Sometimes, we look for more meaningful information. This website https://keepachangelog.com/en/1.0.0/ suggests a different way to write a changelog, with Types of changes:

- Added for new features.
- Changed for changes in existing functionality.
- Deprecated for soon-to-be removed features.
- Removed for now removed features.
- Fixed for any bug fixes.
- Security in case of vulnerabilities.

I used to use this [codelog tool](https://github.com/codus/codelog/blob/master/README.md) in a [Brazilian project I maintained](https://github.com/abntex/limarka/tree/master/changelogs) -- text will be in Portuguese.

The setup is pretty easy:

```bash
gem install codelog # no need to add to Gemfile
codelog setup
```

Add to Rakefile:

```ruby
desc "Create a new codelog entry. See https://github.com/codus/codelog/blob/master/README.md#usage"
task 'codelog:new', [:feature] do |t, args|
system 'codelog', 'new', args[:feature]
end
```

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing CHANGELOG.md and the proposed Keep a Changelog categories, then read the linked codelog README and the Rakefile task example. The scope needs to be decided before implementation; done would mean a defined workflow that produces changelog entries with meaningful change types instead of only closed issues and merged pull requests.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.