Comments (3)
The breaking change should be applied at the point of code removal not code deprecation, because that's when the code actually breaks.
Not sure about DPR
and REM
... I quite like the idea that we can pull out an !!!!UPCOMING CHANGES!!!! section if we adopt DPR. But I think I think I'd normally use REF
or CHO
(aka "I'm tidying stuff up") for removal of deprecated code... and you could plausibly deprecate one thing as part of an ENH
or FEA
.
We could treat it a bit like a BREAKING CHANGE in that if you have DEPRECATION in the commit body it knows what it is? Then we can have a deprecation applied orthogonally to the actual purpose of the commit. In essence we're adding multiple attributes to a commit and we want to be careful not to obfucscate that.
from conventional-commits.
Ok I'll update the way I version control deprecations and removals.
I agree about the DEPRECATION
note in the commit body - this gives us greater flexibility as you say. I'll add it as a new feature request.
from conventional-commits.
Superseded by #57
from conventional-commits.
Related Issues (20)
- Add option to add link to relevant pull request in release notes
- Link release note items to commit diff
- Write article on the benefits of conventional-commit-based continuous deployment on Medium for the new website HOT 1
- Mkver comparison incorrect where package.json not in repository root HOT 3
- Missing commits from PR history
- Add style subheading to release notes
- Add whitespace to valid commit header endings
- Add support for `DEPRECATION` notes in commits
- Implement a set of Github Actions
- Consider putting all breaking changes at top of their sections in release notes generator
- Consider using ❌ or similar emoji to denote breaking changes HOT 4
- Allow brackets at end of commit message
- BREAKING-CHANGES has a mismatched format HOT 1
- Add breaking change commit notes to release notes HOT 3
- I want a boom
- Remove line length limit for commit bodies or format it away so upgrade instructions render nicely in markdown
- Improve upgrade instructions format in release notes generator
- Consider merging some of the release notes sections
- TypeError on a PR with many commits HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from conventional-commits.