New Research: Supply Chain Attack on Axios Pulls Malicious Dependency from npm.Details →
Socket
Book a DemoSign in
Socket
Book a DemoSign in

git-commit-template

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

git-commit-template - npm Package Compare versions

Comparing version
1.0.1
 to
1.0.2
+1
-1
.github/workflows/npmpublish.yml
# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
name: Node.js Package
name: publish

@@ -6,0 +6,0 @@ on:

+60
-28
CONTRIBUTING.md
# Contributing Guidelines
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
documentation, we greatly value feedback and contributions from our community.
Thank you for your interest in contributing to our project. Whether it's a bug
report, new feature, correction, or additional documentation, we greatly value
feedback and contributions from our community.
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
information to effectively respond to your bug report or contribution.
Please read through this document before submitting any issues or pull requests
to ensure we have all the necessary information to effectively respond to your
bug report or contribution.
## Reporting Bugs/Feature Requests
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
We welcome you to use the GitHub issue tracker to report bugs or suggest
features.
When filing an issue, please check [existing open](https://github.com/amzn/git-commit-template/issues), or [recently closed](https://github.com/amzn/git-commit-template/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
When filing an issue, please check
[existing open](https://github.com/amzn/git-commit-template/issues), or
[recently closed](https://github.com/amzn/git-commit-template/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20),
issues to make sure somebody else hasn't already reported the issue. Please try
to include as much information as you can. Details like these are incredibly
useful:
* A reproducible test case or series of steps
* The version of our code being used
* Any modifications you've made relevant to the bug
* Anything unusual about your environment or deployment
- A reproducible test case or series of steps
- The version of our code being used
- Any modifications you've made relevant to the bug
- Anything unusual about your environment or deployment
## Contributing via Pull Requests
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
1. You are working against the latest source on the *master* branch.
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
Contributions via pull requests are much appreciated. Before sending us a pull
request, please ensure that:
1. You are working against the latest source on the _master_ branch.
2. You check existing open, and recently merged, pull requests to make sure
someone else hasn't addressed the problem already.
3. You open an issue to discuss any significant work - we would hate for your
time to be wasted.
To send us a pull request, please:
1. Fork the repository.
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
2. Modify the source; please focus on the specific change you are contributing.
If you also reformat all the code, it will be hard for us to focus on your
change.
3. Ensure local tests pass.
4. Commit to your fork using clear commit messages.
5. Send us a pull request, answering any default questions in the pull request interface.
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
5. Send us a pull request, answering any default questions in the pull request
interface.
6. Pay attention to any automated CI failures reported in the pull request, and
stay involved in the conversation.
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
GitHub provides additional document on
[forking a repository](https://help.github.com/articles/fork-a-repo/) and
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
## Setting up project:
Once you have forked and cloned the repository go ahead to
[setup.md](./SETUP.md) file to know how to setup and test the repository.
## Finding contributions to work on
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/amzn/git-commit-template/labels/help%20wanted) issues is a great place to start.
Looking at the existing issues is a great way to find something to contribute
on. As our projects, by default, use the default GitHub issue labels
(enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any
['help wanted'](https://github.com/amzn/git-commit-template/labels/help%20wanted)
issues is a great place to start.
## Code of Conduct
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
This project has adopted the
[Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). For
more information see the
[Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
opensource-codeofconduct@amazon.com with any additional questions or comments.
## Security issue notifications
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
If you discover a potential security issue in this project we ask that you
notify AWS/Amazon Security via our
[vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/).
Please do **not** create a public github issue.
## Licensing
See the [LICENSE](https://github.com/amzn/git-commit-template/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
See the
[LICENSE](https://github.com/amzn/git-commit-template/blob/master/LICENSE) file
for our project's licensing. We will ask you to confirm the licensing of your
contribution.
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
We may ask you to sign a
[Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement)
for larger changes.
+1
-1
package.json
{
"name": "git-commit-template",
"version": "1.0.1",
"version": "1.0.2",
"description": "Set commit template for git packages",

@@ -5,0 +5,0 @@ "bin": {

+3
-0
README.md
# git-commit-template
![npm
publish](https://github.com/amzn/git-commit-template/workflows/publish/badge.svg)
Sets commit template for your git projects. This is a husky plugin which should

@@ -4,0 +7,0 @@ be used on `prepare-commit-msg` hook exposed by git.

+50
-4
SETUP.md

@@ -1,4 +0,50 @@

For setting up this package you can follow the
[Setup javascript package](https://w.amazon.com/bin/view/AmazonReactToolkit/Community/PackageSetup/#HSetupjavascriptpackage)
documentation. Those are generic javascript package guidelines which we follow
for all our javascript based packages.
## Setup project:
For setting up of the project you only need `npm` and `git`.
Once you have forked and cloned the repository move to the package directory and
run `npm` install:
```bash
cd git-commit-template
npm install
```
## Testing the change
This git commit tempalte uses itself to set the commit tmeplate using husky. So
once you are done with your changes in the template just say `git add .` and
`git commit`, you should be showed the message you changed.
If things are not to your satishfaction then just reject the commit by deleting
all the message and change the template.
## Releasing the changes:
We use [github actions](https://github.com/features/actions) to automate the
release process. Our current hook is on release create, this means when the
created tag is released.
Steps:
1. Make your changes(don't forget to up the package version [patch|minor|major]
and raise a pull request. You can use
`npm --no-git-tag-version version [major|minor|patch]` command to
automatically update these versions.
2. Once the changes are merged if you have write permissions on the
[repository](https://github.com/amzn/git-commit-template) you can create a
tag ad push it.
```bash
# create tag
git tag v<<package.version>>
# push tags
git push --tags
```
3. After pushing the tags head over to releases section and go to tags tab. For
the tag that you created if you click on ellipsis you will see an options to
create a release.
4. Provide proper message and create a release. After this our github actions
will take over and publish the master branch to npm repository.