wappalyzer/CONTRIBUTING.md

Contributing

Wappalyzer is an GPLv3 licensed, open source project written in JavaScript. Anyone is welcome to contribute.

Getting started

To get started, see the README.

Submitting changes

• First, run yarn run validate to identify any issues.
• Use descriptive commit messages, e.g. 'Add WordPress detection'.
• Push your commits to a new branch on your own fork.
• Finally, submit a pull request and describe your changes.

Adding a new technology

Wappalyzer uses regular expressions to fingerprint technologies. Refer to the specification for detail.

• Add a new block to src/technologies/*.json. The filename should match the first letter of the technology name (a-z). Use _.json if the first character is a number or symbol.
• Add an icon to src/images/icons. The image must be square, either SVG or PNG (32 x 32 pixels).

Only widely used technologies are accepted. When creating a pull request, include ten or more links to websites that use the application, a GitHub page with at least 1,000 stars or anything that will help establish the size of the user base.

Adding a new category

Please open an issue on GitHub first to discuss the need for a new category.

To add a category, edit src/categories.json and update every locale. You may use the English category name in all of them.

Adding a new translation

To add a new translation, copy the en folder in src/_locales, rename it to the relevant two-letter country code and update the containing messages.json file.

Adding a new feature

Please open an issue on GitHub first. New features and large changes are rarely accepted without prior discussion.