search

gitpoint / git-point

GitHub in your pocket :iphone:
https://gitpoint.co/
MIT License
4.72k stars 791 forks source link

Proposal - Maintaining a ChangeLog #505

Open machour opened 6 years ago

machour commented 6 years ago

I wrote an initial ChangeLog in #504 to help us follow through the tons of changes between versions.

I went through the closed PR since GitPoint was published on github, and I curated the list. (@housseindjirdeh I'm not sure what was in 1.2 and what was in 1.3 though).

The idea would be to update this file every time a PR is merged carrying a significant change to GitPoint. (and RN versions upgrades which seemed important to me)

These changes should be relevant to the end-user, and be formatted as follow:

Minor cosmetic/ui/ux fixes and changes shouldn't be written down. Neither should build related stuff.

The ChangeLog should also be updated with every release of the app to add the version number, release date & create a new master section.

Opinions ?

lex111 commented 6 years ago

@machour great suggestion, but will this be an automated process?

yeskunall commented 6 years ago

How about using something like conventional-changelog? Seems along the lines as suggested by @machour.

machour commented 6 years ago

@yeskunall @lex111 the way I see it, it would be handled manually. (not all PRs should be reflected, and not all PR titles are meaningful)

lex111 commented 6 years ago

@machour and what about this tool? I think it's worth considering automation of the process.

not all PRs should be reflected

If we finally use releases, then this is not a problem.

not all PR titles are meaningful

It is sometimes necessary to edit manually, @andrewda does so now, but it is not the biggest problem either.

machour commented 6 years ago

@lex111 looks promising!

andrewda commented 6 years ago

@lex111 haha yea I guess I'm a bit OCD when it comes to PR titles 🙃

That definitely looks like a useful tool, and could be made even better if we come up with a consistent (but tentative) release schedule.

vitalkanev commented 6 years ago

@lex111 It's Ruby, but this project mainly uses JS. Alternatives (Source):

  1. https://github.com/tschaub/github-changelog -- Based on closed issues
  2. https://github.com/ariatemplates/git-release-notes -- sample - Just a small changelog
  3. https://github.com/lalitkapoor/github-changes -- Simple :man_shrugging:

But then I have a question -- Which generator is better? Ruby one? Or one of the JS-based?