Hello, and thank you for being a part of the Swarms project! Your voice matters and helps shape the direction of this project.
How to Make an Issue
Issues should be created if you see a bug or have a feature request.
Reporting a Problem
If you have any troubles installing the library or have an issue with the package itself, take the following steps (if applicable to your problem):
- Check out the Troubleshooting Guide for trying to fix the problem.
- Try to find the scope of the issue. Is it with the
node-usb? Something else?
- Create an issue make sure to include the following:
- Descriptive title
- Detailed description of bug or problem
- Current setup when applicable (OS,
swarmsversion, Crazyflie and Crazyradio firmware version, etc...)
- Detailed instructions on how to replicate the issue
Suggesting a Feature
Similarly to reporting a problem, create an issue with a detailed title and body. This can include adding functionality to the library, enhancing documentation, and more.
Contributing Your Own Code
Want to help out? Think you can fix a problem yourself? Well go ahead! Fork the repository and create a branch with a descriptive name. After making changes, double check all linting and tests pass, and create a pull request!
This project uses TypeScript. To compile from source, run:
$ npm run ts
During development, it may be useful to automagically compile on any file changes. Do this by running:
$ npm run ts:watch
Make sure your code is formatted correctly by running:
$ npm run lint
Make sure your code passes linting and unit tests by using:
$ npm test
To automatically generate documentation with
$ npm run docs
This will generate an
/api-reference folder with a static site.