Skip to content
This repository was archived by the owner on Jan 11, 2024. It is now read-only.

feat(versioning): Added versioning documentation and bumped version t… #9

Merged
merged 1 commit into from
Feb 23, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions VERSIONING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Versioning Angular-DataTable

Version maintenance is a critical aspect of maintaining a public NPM package. New versions must be carefully managed to ensure they properly publish. Moreso, proper linting and testing must be performed on each version before publishing to ensure a bad version is never published to the public NPM repository.

Please follow this procedure to version angular-datatable before publishing:

## Versioning Procedure

On your development branch:

1. Verify that you have the latest changes from development by rebasing or merging into your branch.
2. Run linting to ensure the code conforms to necessary style rules.
3. Run unit tests to ensure the code properly functions.
4. Bump the version number in package.json:
- Use revisions for small updates that fix bugs that do not otherwise change the functionality
- Use minor versions for small updates to functionality, if changes to not break backwards compatibility
- Use major versions for large updates to functionality, particularly if they involve breaking changes to backwards compatibility
5. PR your changes with the updated version into the develop branch
6. Request a repository owner to merge the changes into master, which will automatically invoke a publish to the public NPM repo
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "angular-datatable",
"version": "2.1.5",
"version": "2.2.0",
"description": "An Angular 2 datatable, with pagination, sorting, expandable rows etc.",
"keywords": [
"angular",
Expand Down