Skip to content

Latest commit

 

History

History
88 lines (65 loc) · 3.45 KB

CONTRIBUTING.md

File metadata and controls

88 lines (65 loc) · 3.45 KB

Contributing to Git External Tool Configuration

Contributions to Git External Tool Configuration are welcome from all!

Git External Tool Configuration is managed via git, with the canonical upstream repository hosted on GitHub.

Git External Tool Configuration follows a pull-request model for development. If you wish to contribute, you will need to create a GitHub account, fork this project, push a branch with your changes to your project, and then submit a pull request.

Please remember to sign off your commits (e.g., by using git commit -s if you are using the command line client). This amends your git commit message with a line of the form Signed-off-by: Name Lastname <[email protected]>. Please include all authors of any given commit into the commit message with a Signed-off-by line. This indicates that you have read and signed the Developer Certificate of Origin (see below) and are able to legally submit your code to this repository.

See GitHub's official documentation for more details.

Getting Started

Prerequisites

  • Install Visual Studio
  • Install the dependent NuGet packages for the projects

Clone or Update the Git Repository

To download the Git External Tool Configuration, clone its Git repository to your local PC.

git clone https://github.com/ni/git-external-tool-configuration

If you already have the Git repository on your local PC, you can update it

git checkout main

git pull

Source code

This repo contains source code under the Source directory. The Visual Studio solution contains two projects:

Solution 'GitConfigurationTool'
   |-- ConfigurationModifier [C# .Net Console Application]
   |-- FileLauncher [C# .Net Console Application]

Building the solution/projects

The projects can be build individually or together by building the solution itself.

Testing

Manual tests needs to be performed for updates.

Developer Certificate of Origin (DCO)

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

(taken from developercertificate.org)

See LICENSE for details about how Git External Tool Configuration is licensed.