Skip to content
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

Add change log file. #225

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

skywinder
Copy link

Hi, as I can see, you carefully fill tags and labels for issues in your repo.

For such cases I create a github_changelog_generator, that generate change log file based on tags, issues and merged pull requests from :octocat: Issue Tracker.

This PR add change log file to your repo (generated by this script).
You can check, how it is look like here: Change Log

Some essential features, that has this script:

  • it exclude not-related to changelog issues (any issue, that has label question duplicate invalid wontfix )
  • Distinguish issues according labels:
    • Merged pull requests (all merged pull-requests)
    • Bug fixes (by label bug in issue)
    • Enhancements (by label enhancement in issue)
    • Issues (closed issues w/o any labels)
  • Generate neat Change Log file according basic change log guidelines.

You can quickly update this file in future by the simple run script: github_changelog_generator rupa/z in your repo folder and it makes your Change Log file up-to-date again!

Hope you find this commit as useful. 😉

Copy link

@dmd dmd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is necessary for z. Also, this is kinda github-spam; this person is the creator of https://github.com/github-changelog-generator and submitted a PR like this to a large number of projects.

@skywinder
Copy link
Author

@dmd I submitted it to those projects, that I like, use and work in good manner with labels and issues, so these tool works well. z id one of them.

@skywinder
Copy link
Author

For these days there are no too much updates, so probaly we don't need chanlog then. So feel fre to close it in this case.
As for actively developments it's quite usefull feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants