search

Chris-Johnston / Easier68k

Work In Progress - A Python M68k assembler and simulator.
https://chris-johnston.me/Easier68k/
MIT License
15 stars 6 forks source link

Add Changelog #122

Open bpas247 opened 6 years ago

bpas247 commented 6 years ago

Currently, we don't have a change log. We can go two ways with this:

  1. Automated change log: using a tool like this.
  2. Manual change log: For every PR and commit, we update the change log file.

We also need to decide what versioning scheme to use (if that hasn't been previously decided). I personally prefer Semantic Versioning.

Chris-Johnston commented 6 years ago

I'm not sure that a changelog should be a priority. In a way, the git commit log on master is kinda acting as a changelog.

While an automated changelog sounds nice, I don't think that there's any point in having a changelog except when making a release.

A manual change log that needs to be updated with each PR and commit would demand a lot of extra work, which I think wouldn't be worth it.

Semantic versioning is great, this has been used already for the proof of concept release: https://github.com/Chris-Johnston/Easier68k/releases

I think that for the next release v0.2.0 we could include a changelog that highlights the most important changes made from the previous release, like all of the opcodes added. This pattern could continue for all the major releases to follow.

bpas247 commented 6 years ago

@Chris-Johnston

I think that for the next release v0.2.0...

How should we organize the features for each release? We could just use GitHub milestones and projects for this.

Chris-Johnston commented 6 years ago

A milestone would do for planning features for a release. We had made a few when this was just a school project for the due dates and those were closed, but new ones could be added.

bpas247 commented 6 years ago

@Chris-Johnston

A milestone would do for planning features for a release.

Should we open up a new issue to discuss the v0.2.0 release and milestone?