Comments (7)
@at-wat @Sean-Der Thoughts? Ideas?
from .goassets.
I am behind this 110%
I have had multiple people email me and say Hey this is fixed
or Hey this regressed
and having a nice CHANGELOG would have made everything so much easier. After fixing the config drift issues @at-wat is doing this is my second biggest organization frustration with Pion.
I am in full support of doing CHANGELOG + standardized commit messages (instead of the arbitrary rules we have right now). @hugoArregui started this here but I just haven't had a chance to get it going everywhere. I am happy with whatever we do! It doesn't matter what direction we move to me, as long as we have something better :)
It's also a bit out of the ordinary compared to most other projects as far as additional things you need to do when contributing.
I am torn. I really want to incentive/reward people that get involved. Especially people that are afraid to get involved in Open Source for the first time. I would be curious if this actually mattered to anyone. If it actually hasn't had an impact I would say delete it. Maybe this is worth a poll we can share via Twitter/Slack?
from .goassets.
Sounds nice to have a CHANGELOG.
Just FYI, I usually work with a middleware Robot Operation System. It has a script to gather commit messages like:
### Forthcoming
- Commit message (#Issue_number)
- Commit message (#Issue_number)
### PREVIOUS_VERSION (DATE)
- Commit message (#Issue_number)
- Commit message (#Issue_number)
and on a new version release, a release script replaces Forthcoming
by VERSION (DATE)
automatically.
from .goassets.
It's also a bit out of the ordinary compared to most other projects as far as additional things you need to do when contributing.
I am torn. I really want to incentive/reward people that get involved. Especially people that are afraid to get involved in Open Source for the first time. I would be curious if this actually mattered to anyone. If it actually hasn't had an impact I would say delete it. Maybe this is worth a poll we can share via Twitter/Slack?
So, I'm not sure if it has an actual impact. But I got caught by it when submitting this PR, since it's my first one to this repo, and my brain went "huh, that's weird". I honestly don't know if it matters at all, but it was a bit weird to see my PR fail on it.
from .goassets.
Based on my discussion in Slack (starting from this message), I'd like to work on this in the near future.
In short: I'd plan to be using Conventional Commits and probably Standard Version to automatically generate a changelog (and perhaps automated releases if we want to).
from .goassets.
Seems like it's still undecided: automated change log based on commit messages or doing it by hand. IMO, change logs should be maintained by us humans as they are targeted at the user unlike commit messages which are targeted at developers. Commit messages are more technical in nature and more detailed and while some commit messages can be copied directly to the change log, most are too detailed|cryptic for the non-developer.
FYI, There is a github action, mindsers/changelog-reader-action, that reads the changelog (provided we adhere to keepachangelog format) and extracts the version information. Here's how I use it.
from .goassets.
I am adding a link to this comment by Sean about conventional commits:
Maybe it could be a way to generate a Changelog automatically
from .goassets.
Related Issues (20)
- Golangci-lint uses deprecated linters
- Add CodeQL workflow HOT 2
- Undefined environment variable GITHUB_WORKSPACE HOT 2
- Move contributor list from README.md to AUTHORS.txt
- Add editorconfig file HOT 1
- Improve commit message linter output
- Add REUSE compliancy check
- generate-authors should create a separate commit
- Allow single line commit messages HOT 6
- Rewrite shell scripts in Go HOT 7
- LICENSE file is missing HOT 10
- Enable gotestfmt for i386 tests HOT 2
- Remove AUTHORS.txt HOT 4
- Pass Codecov upload token to codecov/codecov-action HOT 2
- Golangci-lint fails randomly by undefined: webrtc (typecheck)
- Split API compatibility check from test job
- Commit message lint script doesn't handle different base branch
- #196 introduced a lot of new lint errors HOT 2
- Blacklist usage of testify/assert HOT 2
- Use test.TimeOut and test.CheckRoutines as one liner
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 .goassets.