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.

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

Maintain a changelog file #25

Merged
merged 3 commits into from Dec 15, 2017
Merged

Maintain a changelog file #25

merged 3 commits into from Dec 15, 2017

Conversation

mmacai
Copy link
Collaborator

@mmacai mmacai commented Dec 14, 2017

Changes

  • added CHANGELOG.md and related ADR
  • filled CHANGELOG.md with all recent changes
  • mix docs should work and generate new content

Notes

  • once we'll have umbrella setup we can add ### headers and differentiate between direct changes in given sub application
    e.g.
### Proxy

- Changed
  - ...

- Fixed
  - ...

### Monitoring

- Changed
  - ...

Decided to use PR numbers/links in notes. Downside is that you have to either guess (look at most recent PR and increment that by 1) your PR number or do one more commit after PR submit. But I think it's better to be redirected to PR and see code immediately rather than be redirected to issue and go through possibly long page to find out proper PR change.

@mmacai mmacai mentioned this pull request Dec 14, 2017
@kevinbader
Copy link
Contributor

Thanks, fully agree to the changes.

Regarding finding out the PR number - I'd just create the PR with [WIP] in the title and if the number was incorrent just amend and force-push the branch 🕺

@mmacai mmacai merged commit 8f0f164 into master Dec 15, 2017
@kevinbader kevinbader deleted the feature/changelog branch December 24, 2017 08:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants