Skip to content

Commit

Permalink
Add PR template and CHANGELOG (#28)
Browse files Browse the repository at this point in the history
  • Loading branch information
david-yz-liu authored May 3, 2024
1 parent 76c7630 commit 8e91619
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 0 deletions.
52 changes: 52 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
## Proposed Changes

_(Describe your changes here. Also describe the motivation for your changes: what problem do they solve, or how do they improve the application or codebase? If this pull request fixes an open issue, [use a keyword to link this pull request to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).)_

...

<details>
<summary>Screenshots of your changes (if applicable)</summary>

</details>

## Type of Change

_(Write an `X` or a brief description next to the type or types that best describe your changes.)_

| Type | Applies? |
| --------------------------------------------------------------------------------------- | -------- |
| 🚨 _Breaking change_ (fix or feature that would cause existing functionality to change) | |
|_New feature_ (non-breaking change that adds functionality) | |
| 🐛 _Bug fix_ (non-breaking change that fixes an issue) | |
| 🎨 _User interface change_ (change to user interface; provide screenshots) | |
| ♻️ _Refactoring_ (internal change to codebase, without changing functionality) | |
| 🚦 _Test update_ (change that _only_ adds or modifies tests) | |
| 📚 _Documentation update_ (change that _only_ updates documentation) | |
| 📦 _Dependency update_ (change that updates a dependency) | |
| 🔧 _Internal_ (change that _only_ affects developers or continuous integration) | |

## Checklist

_(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the `[ ]` into a `[x]` in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)_

Before opening your pull request:

- [ ] I have performed a self-review of my changes.
- Check that all changed files included in this pull request are intentional changes.
- Check that all changes are relevant to the purpose of this pull request, as described above.
- [ ] I have added tests for my changes, if applicable.
- This is **required** for all bug fixes and new features.
- [ ] I have updated the project documentation, if applicable.
- This is **required** for new features.
- [ ] If this is my first contribution, I have added myself to the list of contributors.
- [ ] I have updated the project Changelog (this is required for all changes).

After opening your pull request:

- [ ] I have verified that the CI tests have passed.
- [ ] I have reviewed the test coverage changes reported by Coveralls.
- [ ] I have [requested a review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review) from a project maintainer.

## Questions and Comments

_(Include any questions or comments you have regarding your changes.)_
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased

### 🚨 Breaking changes

### ✨ Enhancements

### 🐛 Bug fixes

### 📚 Documentation and demo website changes

### 🔧 Internal changes

- Added a changelog and pull request template.

## [0.1.0] - 2024-04-16

Initial release to [NPM](https://www.npmjs.com/package/memory-viz).
For changes up to this release, see the [commit history](https://github.com/david-yz-liu/memory-viz/commits/master/).

0 comments on commit 8e91619

Please sign in to comment.