Skip to content

Latest commit

 

History

History
22 lines (17 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

22 lines (17 loc) · 1.27 KB

Contribution guidelines

IMPORTANT: IF YOU WANT TO REPORT A SECURITY VULNERABILITY, PLEASE USE SECURITY ADVISORIES TO FILE A PRIVATE REPORT.

If you wish to contribute to the Float Toolkit codebase, feel free to fork the repository and submit a pull request.

Steps

  1. Refer to the documentation to make sure the error is actually a bug and not a mistake of your own.
  2. Make sure the issue hasn't already been reported or suggested.
  3. Fork and clone the repository, and checkout the corresponding branch (docs for documentation, master for anything else). DO NOT modify the stable branch.
  4. Make your changes (add or modify tests and documentation comments as necessary to cover your changes).
  5. Run npm run build (or VSCode task ESBuild: Compile and generate documentation) to run the tests and build the package and documentation (you can use npm link to try it locally).
  6. Submit a pull request.