Code Monkey home page Code Monkey logo

psykorebase's People

Contributors

benoitbryon avatar natim avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

natim realyze

psykorebase's Issues

git psykorebase --help fails because there is no man page for it.

--help doesn't works:

$ git psykorebase --help
Aucune entrée de manuel pour git-psykorebase
voir « man 7 undocumented » pour obtenir de l'aide quand les pages de manuel ne sont pas disponibles.

Also -h works:

$ git psykorebase -h
usage: git-psykorebase [-h] [--no-ff] [--continue] [--ask]
                       [PRIMARY-BRANCH] [SECONDARY-BRANCH]

Perform safe merged-based rebases.

positional arguments:
  PRIMARY-BRANCH    Branch you want to apply changes on top of.
  SECONDARY-BRANCH  Branch with changes you want to rebase.

optional arguments:
  -h, --help        show this help message and exit
  --no-ff           Force a commit message for the psykorebase.
  --continue        Continue the rebase after a merge conflict.
  --ask             Ask confirmation before each command.

tests/ folder lives at the root of the repository

Since "tests/" folder doesn't contain tests that can be used as a library, there is no reason to distribute package psykorebase.tests. Moreover, tests may require dependencies that aren't required to run psykorebase command.
=> Let's mv psykorebase/tests tests

README explains concept using pictures

Pictures are easier to understand than words. Try to illustrate the concept using schemas.
Perhaps a comparison between merge, rebase and psykorebase workflows.

README references main project's resources

In order to find documentation, code repository and such resources about the project, I want links in locations like Github/psykorebase, PyPI/psykorebase, readthedocs/psykorebase, ...

An easy way to do it is to add such links in README.

Tox runs tests

Run tests using tox so that it is easy to manage multiple development environments.

Documentation explains usage

As of version 1.0.1, documentation (README) explains both current and planned usage.
Should be current usage only.

Also, documentation should explain usage and options.
Showing output from psykorebase --help may be enough.

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.