Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (19 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.3 KB

Contribute

We are happy to receive your contributions to improve this website or add more cybersecurity tools and share them with the community. Before you start contributing please note the following guidelines:

Report bugs or request a new or tool

If you want to report a bug, typo errors, wrong information or even request a new feature or a new tool you can do it in the Issues section of the repository of this project.

Try to be as detailed and concise as possible. If necessary, include screenshots or videos to give more context to your request.

Contribute with coding

Great! We love to receive code contributions, but before you start, you will need to install a couple of dependencies and follow the steps below:

Dependencies

  • Node.js 18.13.0 (We recommend using NVM or FNM)
  • Visual Studio Code Editor
  • Eslint VS Code Extension
  • Prettier VS Code Extension
  • Git 2.3 or latest

Steps to contribute with coding:

  1. Fork the project repository
  2. Make a git clone of the project
  3. Install the project dependencies with npm install
  4. Make your changes and upload them to the forked repo on Github.
  5. Open a Pull Request in the original repository. Include a detailed description of the changes you have made. If necessary, include screenshots or videos to give more context to your changes.