Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

66 lines (45 loc) · 1.64 KB

Contributing

Contributions are very welcome! Below are some helpful guidelines.

How to build the project

mob requires at least Go 1.15 to build:

$ cd /path/to/git/clone/of/remotemobprogramming/mob
$ go build

Running single test files during development is probably easiest in your IDE. To check if all tests are passing, simply run

$ go test -v

To do some manual testing, you can install the new binary to /usr/local/bin/:

$ ./install

Afterwards, you can check if everything works as you expect. If it does not, you might want to add the --debug option to your call:

$ mob config --debug

How to contribute

If you want to tackle an existing issue please add a comment on GitHub to make sure the issue is sufficiently discussed and that no two contributors collide by working on the same issue. To submit a contribution, please follow the following workflow:

  • Fork the project
  • Create a feature branch
  • Add your contribution
  • Test your changes locally, i.e. do an ./install and try your new version of mob
  • Run all the tests via go test -v, and if they pass:
  • Create a Pull Request

That's it! Happy contributing 😃

Going back to the official release

When you've finished local testing (and you've created a pull request), maybe you want to go back to the official mob releases. If you're using a package manager, you probably have to delete your locally built binary first ...

rm /usr/local/bin/mob

... and then reactivate the mob version provided by your package manager. If you're using Homebrew, it works like this:

brew unlink mob && brew link mob