CONTRIBUTING.MD

Thank you for contributing to the Dependabot for Azure DevOps project.

Table of Contents

• Contribution workflow
• Development environment
• Submitting pull requests
  • Unit tests
  • Static code analyzers and linters
  • Formatters
  • Spelling
  • Automatically run quality checks on commit

Contribution workflow

1. Fork the project.
2. Get the development environment running.
3. Make your feature addition or bug fix.
4. Make sure all required quality checks have passed.
5. Send a pull request.

Development environment

Before contributing, you'll need to configure your local development environment; View the corresponding development guide for the component you'd like to contribute to:

• Azure DevOps Extension
• Dependabot Server
• Dependabot Updater image

Submitting pull requests

If you plan on submitting a pull request, there are several quality checks that must pass; It is recommended that you run these before submitting the pull request. The checks are:

Unit tests

All existing unit tests must pass. View the corresponding unit test instructions for the component you'd like to test:

• Azure DevOps Extension
• Dependabot Server
• Dependabot Updater image

Static code analyzers and linters

Some components use static code analyzers and linters. View the corresponding instructions for each component:

• Dependabot Updater image

Formatters

npm install
npm run format:check        # to check for formatting issues
npm run format              # to automatically fix formatting issues

Spelling

pip install codespell
codespell                   # to check for misspellings
codespell --write-changes   # to automatically fix misspellings

Automatically run quality checks on commit

If you'd like spelling, formatting, and linting checks to be run automatically on commit, enable the Husky git hooks using:

npx husky

When enabled, your local commits will be rejected if any of the quality checks fail; Unit tests are not run due to their long execution time, you must still run them manually.