Skip to content

Latest commit

 

History

History
30 lines (18 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

30 lines (18 loc) · 1.36 KB

Contributing to aikido-api-client

Are you missing functionality or have you found a bug? Please feel free to add an issue or submit a PR. We try to be responsive and release updates and fixes as fast as possible.

Reporting issues

This package uses the GitHub Issue Tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted.

Contributing code

If you want to add additional tags, attributes or functionality to the library, please feel free to create a pull request with your changes.

Please try to follow this workflow:

  • Fork the project
  • Create a new branch forked from the main branch with a title for your feature (e.g. feature-that-i-want)
  • Commit all your code into this branch until you are happy with your contribution
  • Create a pull request with your commits

Formatting ⚠️

Please try to follow editor settings provided in .editorconfig and .prettierrc. If you are using an editor like VS Code your editor should automatically parse these files and auto-format your files on save. If not, you can re-format all source files with the following command:

$ yarn format

Unit testing ⚠️

No unit tests are currently available for the cli tool.