Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (41 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

62 lines (41 loc) · 2.25 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. You can contribute in the ways listed below.

This repository primarily contains LabVIEW VIs, NI-MAX configuration and mechanical design files. Independently edited .vi binaries cannot be merged reliably; coordinate LabVIEW changes before editing and use the repository hierarchy as the canonical copy.

Report Bugs

Report bugs using GitHub issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

JoystickPushTask can use clearer rig inventory, calibration, validation and fabrication notes. Keep hardware claims tied to a dated bench test, and place mechanical source files under mechanical/ with descriptive filenames and a short part README.

Submit Feedback

The best way to send feedback is to file an issue on GitHub.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started

Ready to contribute? Clone JoystickPushTask locally. LabVIEW and a compatible NI-DAQmx version are required to open and run the VIs; they are not required for documentation-only changes.

  1. Fork the repo on GitHub.
  2. Clone your fork locally.
  3. Create a branch and make the smallest coherent change.
  4. For VI changes, verify the full local hierarchy opens and run the relevant bench tests.
  5. Commit and push the branch.
  6. Submit a pull request describing hardware assumptions and validation performed.

Code of Conduct

Please note that JoystickPushTask is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.