Deploy custom push protections and policies
on top of Git

npm install @finos/git-proxy

Report a bug · Suggest a new feature

Git Proxy deploys custom push protections and policies on top of Git. It is a highly configurable framework allowing developers and organizations to enforce push protections relevant to their developer workflow, security posture and risk appetite.

Git Proxy is built with a developer-first mindset. By presenting simple-to-follow remediation instructions in the CLI/Terminal, it minimises the friction of use and adoption, and keeps developers focused on what matters; committing and pushing code.

To install Git Proxy, use the npm package manager:

$ npm install @finos/git-proxy

To install a specific version of Git Proxy, append the version to the end of the install command:

$ npm install @finos/git-proxy@1.0.0

Your contributions are at the core of making this a true open source project. Any contributions you make are greatly appreciated.

Click on the fork button at the top of the page. This will create a copy of this repository under your GitHub account.

Clone the repository to your machine. Go to the repository via your GitHub account and click on the Code button.

Run the following command in your CLI/Terminal:

$ git clone https://github.com/YOUR_GITHUB_USRERNAME/git-proxy.git

You can start coding on the default branch on your fork of the project, commonly master or main. If you want to create a branch to clearly identify your work, run:

$ git checkout -b feature/name-of-the-feature-you-are-creating

This part is up to you. Be creative and write some magical code! 🧙🪄

Once you have finished making all of your improvements and changes, run the following:

$ git commit -m "YOUR COMMIT MESSAGE"

Now that you've created a commit with your changes, it's time to push to GitHub:

git push

With your changes applied to your fork of the project, it's time to open a pull request from your repository...

If you identify a security vulnerability in the codebase, please follow the steps in SECURITY.md. This includes logic-based vulnerabilities and sensitive information or secrets found in code.

We are committed to making open source an enjoyable and respectful experience for our community. See CODE_OF_CONDUCT for more information.

This project is distributed under the Apache-2.0 license. See LICENSE for more information.

If you have a query or require support with this project, raise an issue. Otherwise, reach out to help@finos.org.