1. Fork the project, clone your fork, and configure the remotes:
a. Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/object-size-cli
b. Navigate to the newly cloned directory
cd object-size-cli
c. Assign the original repo to a remote called upstream
git remote add upstream https://github.com/wesselbaum/object-size-cli
git checkout develop
git pull upstream develop
IMPORTANT: We are using
develop
branch for development, notmaster
.
git checkout -b <topic-branch-name>
Run npm test
to check that all tests pass after you've made changes.
git pull --rebase upstream develop
git push origin <topic-branch-name>
8. Open a Pull Request to a develop
branch with a clear title and description.
- All non-trivial changes should be put up for review using GitHub Pull Requests.
- Your change should not be merged into
develop
, without at least one "OK" comment from another maintainer/collaborator on the project. - Once a feature branch has been merged into its target branch, please delete the feature branch from the remote repository.
- Include all new functional changes in the CHANGELOG.
- Use a dedicated commit to increment the version. The version needs to be
added to the
CHANGELOG.md
(inc. date) and thepackage.json
. - The commit message must be of
v0.0.0
format. - Merge
develop
intomaster
. - Create a tag for the version:
git tag v0.0.0
. - Push the changes and tags to GitHub:
git push origin develop master v0.0.0
. - Publish the new version to npm:
npm publish
.