Skip to content

Latest commit

 

History

History
executable file
·
35 lines (20 loc) · 1.81 KB

CONTRIBUTING.rst

File metadata and controls

executable file
·
35 lines (20 loc) · 1.81 KB

Reporting bugs

If you find a bug, please open an issue on the Github issues tracker. Please provide some code that reproduces the error and versions of the packages installed.

Contributing code

To contribute code we recommend you follow these steps:

  1. Fork the repository on github
  1. Clone the repository to your favorite location on your drive where you want to work on it. You never want to clone again.
  2. Use Matlab's addpath command to add the vtoolbox directory to your installation of Matlab. Alternatively, use the GUI pathtool.
  3. Add your code/make your modifications, committing to your fork.
  4. Update from the main repository before submitting a pull request. This allows you to see the complete results before we look at them. If it doesn't work, the pull will (should) be denied.
  5. Sync to your computer (called Fetch origin in the new GitHub app.)
  6. Make a git pull (in your GitHub app) to assure that your code is up to date with the master branch and that your code has no conflicts with the current base. Doing this regularly ensures that your accumulated edits won't be massively in conflict with the existing code base. After that, commit your branch to github and then open a pull request.

Installing

If you are just trying to install:

  1. Clone the vibration toolbox repository to your favorite location on your drive where you want to work on it. You never want to clone again.
  2. Use Matlab's addpath command to add the vtoolbox directory to your installation of Matlab. Alternatively, use the GUI pathtool.
  3. Sync to your computer (called Fetch origin in the new GitHub app.) to get updates.