Skip to content

Latest commit

 

History

History
143 lines (118 loc) · 6.21 KB

CONTRIBUTING.md

File metadata and controls

143 lines (118 loc) · 6.21 KB
Raw

Contributing

Hi there! We are thrilled that you would like to contribute to this project. Your help is essential for keeping it great.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. If an issue is opened and more info is needed, airgeddon staff will request it. If there is no answer in 7 days, the issue will be closed.

Please note we have a Code of Conduct, please follow it in all your interactions with the project.

Collaborating Translators

  1. Update the date under shebang.
  2. Translate the strings located in language_strings.sh.
  3. Ask by mail [[email protected]] if you have any doubt. You'll be informed about how to proceed.
  4. You can be added as a collaborator on the project.
  5. Knowledge about git is not mandatory but is really appreciated to push directly into the project repository.

Collaborating Developers

  1. Tweak "debug_mode" variable to "1" for faster development skipping intro and initial checks or to "2" for verbosity and the skips mentioned before.
  2. Respect the 4 width tab indentation, code style and the UTF-8 encoding.
  3. Use LF (Unix) line break type (not CR or CRLF).
  4. Use Shellcheck to search for errors and warnings on code. (Thanks xtonousou for the tip 😉). To avoid false positive warnings you must launch shellcheck using -x argument to follow source files and from the directory where airgeddon.sh is. For example: cd /path/to/airgeddon && shellcheck -x airgeddon.sh
  5. Increase the version numbers in airgeddon.sh, in Readme and in Changelog to the new version that the script represents. The versioning scheme we use is X.YZ. Where:
  • X is a major release with a new menu (e.g. WPS menu)
  • Y is a minor release with a new feature for an existing menu or a new submenu for an existing feature
  • Z is a minor release with new bug fixes, small modifications or code improvements
  1. Update the date on .sh and .db files under shebang, if appropriate.
  2. Split your commits into parts. Each part represents a unique change on files.
  3. Direct push to Master is not allowed.
  4. Pull Requests to Master are not allowed. Should be done over Dev or any other branch. They require revision and approvement.
  5. All the development and coding must be in English.

Be sure to merge the latest from "upstream" before making a pull request!

We also have a private Telegram group for trusted collaborators for more agile discussion about developments, improvements, etc. To be added on it you must prove first you are a trusted collaborator with your contributions.

WPS PIN Database Collaborators

  1. Send MAC of the BSSID and the default PIN to [[email protected]]. If you are going to push directly into the repository, keep reading the next points.
  2. Add PINs ordered by the key in the associative array located in the known_pins.db file. (Keys are the first 6 BSSID digits).
  3. Update the pindb_checksum.txt file with the calculated checksum of the database file using md5sum tool.
  4. Update the date under shebang.

PINs should be from devices that generate generic ones.

Beta Testers

  1. Download the master version or the beta testing version from the development branch called Dev. Temporary branches may be existing for specific features that can be tested too.
  2. Report any issues or bugs by mail [[email protected]] or submit issue requests Here.

Donate

If you enjoyed the script, feel free to donate. Support the project through Paypal or sending a fraction any of these cryptocurrencies. Any amount, not matter how small (1, 2, 5 $/€) is welcome:

Paypal: [email protected]
Bitcoin: 1NSzwqtBBdo4CrvynPZmd85xfbL7hw3Ptu
Bitcoin Cash: 1GyUesBgwHKZBeFvkT5nfteecPdH6bAEaL
Dash: XgKL8GTsdKAL2fypiMRFFL8m4wWTm1Netn
Ethereum: 0xf88107ba5e10776a37ec089a7ed2bac57638eea7
Litecoin: LX1ytoQhRzUAuArpkNRjnfTmwYuxxJezTn
ZCash: t1dt1ZDCgDUt9pqnyzkZd9GE2NpZBfMVsXq


Bitcoin QR code: Bitcoin Cash QR code: Dash QR code:
Ethereum QR code: Litecoin QR code: ZCash QR code: