The set of extensions that integrates the API-design essential tools into your everyday work.
This repository contains the API Scoring and Quick Fix extensions that integrate with your IDE to interact with breached API rules, and the SPA that is displayed on the IDE.
You can find further information regarding the API Scoring Suite in our documentation site!
You can see that in the root of this repository, there is a plugins/ folder. This folder contains the SPA package, the API Scoring for VS Code package, the API Scoring for IntelliJ package, and the Quick Fix for VS Code package.
To proceed with their installation, please, place yourself in their path and follow the installation guides suggested in the READMEs. It is convenient that you follow a specific order of installation:
- Deploy the microservice by following its installation guide.
- Deploy the SPA following its installation guide.
- Install the plugins by following their installation guides inside each README file or checking the installation guide.
View the documentation for usage information.
Bug reports, proposals of new features, and pull requests are always welcome, so feel free to contribute to the project following the Contributor Covenant code of conduct.
If you want to contribute, you should do the following:
- Submit an issue that motivates the changes.
- Discuss the proposed changes with other users and the maintainers.
- Open a Pull Request.
- Ensure all CI tests pass.
- Provide instructions to check the effect of the changes.
- Await code review.
This set of tools is available as open source under the terms of the MIT License.