Giter VIP home page Giter VIP logo

tfs-pullrequest's Introduction

Code review TFS

Installation

Please go to the releases tab in order to download the latest stable release.

The installer should install the command on your machine with no need for you to interviene.

Configuration

On your first execution of the command you will be asked for three informations, your TFS root URL, username and password.

After that your command will be ready for using

Commands available

$ cr feature

    This will list all features on your current repository.

$ cr feature [-f|--finish] {feature_name}

    This will create a new feature (branch) for you to work on.
    
    This command will always create a branch from master, so if you use ir from another feature, 
    it will not move or delete modifications you might have done
    
    If -f or --finish parameter is informed, it will try to finish feature {feature_name} instead of
    creating it. If you inform the -f parameter but does not inform {feature_name}, it will try
    to finish your current feature

$ cr move {feature_name}

    This command will switch your active feature to {feature_name}

$ cr review [[-t|--title] {pull_request_title}] [--hotfix]

    This command will create (or update) a pull request with your modifications and try to merge them on
    the master branch.
    
    The parameters -t or --title are used to inform the title of the pull request, if you do not inform
    any, it will use the last commit message as the title.
    
    If you try to create a pull request on master, it will first create a feature using your pull request
    title and then create a pull request accordingly.
    
    The parameter --hotfix is used if the changes are emergencial or do not need to be reviewed, i.e., the 
    pull request will be automatically merged into master.

$ cr share

    Pushes current feature to server without creating pull request, making it available for all users.

$ cr update

    Merge master branch into current feature and pulls any changes. (useful to resolve conflicts)

How to generate distribution (for those seeking to help with the project)

You will need to install PyInstaller and InnoSetup.

Then, follow these steps to generate the windows installer:

  1. Change the version of the software on main.py and /release/installation-script.iss, based on the release version you want to create.

  2. Go to the root folder (the repository root) and execute the following command:

    $ pyinstaller -n cr main.py -y

    This wil generate the files you need to install on the clients computer, you can see them on /dist/cr/

    pyinstaller is an alias for python pyinstaller.py

  3. Open the InnoSetup file located on /release/installation-script.iss

    Execute it, it will generate the installer called Codereview Installer.exe located on the /dist folder.

  4. Create a new release on GitHub with the same release version you set up on step one, and upload the windows installer. I generally also upload a zip file containing the contents from the /dist/cr folder so you have the option of just copying the files.

tfs-pullrequest's People

Contributors

yuriclaure avatar

Watchers

Diogo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.