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.

Sign up for GitHub

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

Jump to bottom

docs(changelog): Add 'CHANGLOG.md' #4600

Merged
merged 5 commits into from
Dec 29, 2021
Merged

docs(changelog): Add 'CHANGLOG.md' #4600

merged 5 commits into from
Dec 29, 2021

Conversation

niheaven
Copy link
Member

@niheaven niheaven commented Dec 26, 2021 •
edited
Loading

Generated by git-chglog and manually reorganized.

Commits before https://github.com/ScoopInstaller/Scoop/releases/tag/2019-05-12 and those don't follow Conventional Commits will be added soon.

Hope this should be done ONLY ONCE 😭

Ref: Conventional Commits / Git Commit Msg

Suggested commit message:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Suggested type:

  • feat (Features) for a new feature for the user, not a new feature for build script. Such commit will trigger a release bumping a MINOR version.
  • fix (Bug Fixes) for a bug fix for the user, not a fix to a build script. Such commit will trigger a release bumping a PATCH version.
  • perf (Performance Improvements) for performance improvements. Such commit will trigger a release bumping a PATCH version.
  • docs (Documentation) for changes to the documentation.
  • style (Styles) for formatting changes, missing semicolons, etc.
  • refactor (Code Refactoring) for refactoring production code, e.g. renaming a variable.
  • test (Tests) for adding missing tests, refactoring tests; no production code change.
  • build (Builds) for updating build configuration, development tools or other changes irrelevant to the user.
  • ci (Continuous Integration) for changes to CI/CD configuration files and scripts (example scopes: GitHub Actions, Excavator, etc.)
  • breaking (BREAKING CHANGE) for breaking API changes or CLI changes
  • (not recommend) chores (Chores) for changes to the build process or auxiliary tools and libraries such as documentation generation, don't modify src or test files

Notes about type

  • docs: README.md and some function documents
  • style: formatting, e.g., white spaces, function case changes, output beautifying
  • refactor: rewriting or refactoring functions
  • test: changes in test directory and not in appveyor.yml
  • build: changes in bin and supporting directories, plus schema.json
  • ci: changes in appveyor.yml and (optional) test directory
  • breaking: breaking changes that may affect manifest structure or CLI in libexec directory

type and scope should be chosen by what and where key change occurred.

@niheaven
Copy link
Member Author

niheaven commented Dec 27, 2021 •
edited
Loading

This comment has been moved to first comment.

rashil2000
rashil2000 reviewed Dec 27, 2021
View reviewed changes
CHANGELOG.md Outdated Show resolved Hide resolved
@niheaven
Copy link
Member Author

Would full changelog be added here? Or when will I add unorganized commits log to CHANGELOG.md from?

IMO, commits log before 2018 should be useless now... @ScoopInstaller/maintainers

@rashil2000
Copy link
Member

I think if you have them written already, we can add them. They're for older releases, so it doesn't matter if they're unorganised.

@niheaven niheaven marked this pull request as ready for review December 28, 2021 12:43
@niheaven niheaven requested a review from a team December 28, 2021 12:44
@niheaven niheaven merged commit 36ae35c into develop Dec 29, 2021
@niheaven niheaven deleted the add-changelog branch December 29, 2021 13:38
@niheaven niheaven mentioned this pull request Mar 2, 2022
Merged
se35710 pushed a commit to se35710/scoop that referenced this pull request Mar 8, 2022
@niheaven @se35710
docs(changelog): Add 'CHANGLOG.md' (ScoopInstaller#4600)
9940a4f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rashil2000 rashil2000 rashil2000 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@niheaven @rashil2000