https://github.com/ascendcorp/pre-commit-go

https://github.com/ascendcorp/pre-commit-go

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/ascendcorp/pre-commit-go
• Owner: ascendcorp
• License: mit
• Created: 2023-05-02T03:10:00.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-07T04:59:24.000Z (over 1 year ago)
• Last Synced: 2023-08-07T05:47:05.926Z (over 1 year ago)
• Size: 6.84 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pre-commit Hooks for ACW Project

This repository contains pre-commit hooks for Golang projects.

## How to Use

To use these pre-commit hooks in your Golang project, follow these steps:

1. Install the `pre-commit` tool by running `pip install pre-commit` in your terminal.

2. Create a `.pre-commit-config.yaml` file in the root of your project with the following contents:

   ```yaml

   repos:

     - repo: https://bitbucket.org//

       rev:   # Replace with the commit hash of the latest version of this repository

       hooks:

         - id: go-sec

         - id: dependency-check

3. Run `pre-commit install` in your terminal to install the pre-commit hooks in your local repository.

4. Commit the `.pre-commit-config.yaml` file to your repository.

5. Now, every time you run `git commit`, the pre-commit hooks will automatically run and check your code for security vulnerabilities and outdated dependencies.

## How to Contribute

To contribute to this repository, follow these steps:

1. Fork this repository on Bitbucket.

2. Clone your forked repository to your local machine.

3. Create a new branch for your changes: `git checkout -b my-new-branch`.

4. Make your changes and commit them: `git commit -am 'Add some feature'`.

5. Push your changes to your forked repository: `git push origin my-new-branch`.

6. Create a pull request from your forked repository to this repository.

7. Wait for the maintainers to review and merge your pull request.