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

Add changelog file #76

Merged
merged 5 commits into from
Jul 8, 2019
Merged

Add changelog file #76

merged 5 commits into from
Jul 8, 2019

Conversation

jklenzing
Copy link
Member

@jklenzing jklenzing commented Jul 5, 2019

Description

Adds CHANGELOG.md and requires pull requests to summarize changes there.

Type of change

  • This change is a documentation update

Checklist:

  • Make sure you are merging into the develop (not master) branch
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@jklenzing jklenzing added this to the 0.2.0 Release milestone Jul 5, 2019
@jklenzing jklenzing added the documentation Improve the description of the code label Jul 5, 2019
Copy link
Collaborator

@JonathonMSmith JonathonMSmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this TBD format what should be used when submitting a pull request?

@jklenzing
Copy link
Member Author

My plan is for the TBD to be updated as part of the pull to master, since that is when the version will be applied. Probably a more elegant way of doing this, but it works for now.

@jklenzing jklenzing merged commit 4edb577 into develop Jul 8, 2019
@jklenzing jklenzing deleted the jklenzing-patch-1 branch July 8, 2019 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve the description of the code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants