Skip to content

Latest commit

 

History

History
165 lines (136 loc) · 8.87 KB

CONTRIBUTING.md

File metadata and controls

165 lines (136 loc) · 8.87 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. Please read the Issue Creation Policy shown below before creating it.

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

Issue Creation Policy

  1. Filling the issue template with ALL the requested info is mandatory. Otherwise the issue can be marked as "invalid" and closed immediately.
  2. Issues must be opened in English.
  3. If an issue is opened and more info is needed, airgeddon staff will request it. If there is no answer in 7 days or the OP is not collaborating, the issue will be closed.
  4. If the issue is not related to airgeddon or the root cause is out of scope, it will be closed. airgeddon staff is not a helpdesk support service.
  5. Try to be sure that your problem is related to airgeddon and that is not a driver issue. A good practice is always to try to perform the same operation without using airgeddon in order to see if the problem or the behavior can be reproduced. In that case, probably the issue should not be created.

Collaborating Translators

  1. Ask ALWAYS before start a translation to add a new language ([v1s1t0r.1s.h3r3@gmail.com]). Contact to the development team in order to know what are you going to do. You'll be informed about how to proceed.
  2. Once new language is approved or if you are going to update an existing one, update the date under shebang on every commit.
  3. Translate the strings located in language_strings.sh and the existing phrases language_strings_handling_messages function in airgeddon.sh.
  4. If you want to create a pull request with a new language to be added, at least the 80% of the phrases must be translated and the rest must be done with at least an automatic-translation system and marked with PoT (Pending of Translation) mark.
  5. Remember that pull requests done over master branch will be rejected. Read the git workflow policy first.
  6. After verification of and acceptation of the pull request, you can be added as a collaborator on the project to push directly on the repository instead of making pull requests.
  7. Knowledge about git is mandatory (at least basic commands) to push directly into the project repository.

Collaborating Developers

  1. First of all ask ALWAYS before performing a development. Ask to the developement team to set what is going to be
  2. Tweak "AIRGEDDON_DEVELOPMENT_MODE" variable to "true" for faster development skipping intro and initial checks or change "AIRGEDDON_DEBUG_MODE" variable for verbosity.
  3. Respect the 4 width tab indentation, code style and the UTF-8 encoding.
  4. Use LF (Unix) line break type (not CR or CRLF).
  5. 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
  6. 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. Pull Requests to Master are not allowed. Should be done over Dev or any other branch. They require revision and approvement. Read the git workflow policy first.
  4. 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. Anything ca be also discussed on the IRC channel. More info on Wiki Contact Section

WPS PIN Database Collaborators

  1. Send MAC of the BSSID and the default PIN to [v1s1t0r.1s.h3r3@gmail.com]. 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 main version from the Master branch or the beta testing version from the development branch called Dev. Temporary branches may be existing for specific features that can also be tested.
  2. Report any issues or bugs by mail [v1s1t0r.1s.h3r3@gmail.com] or submit issue requests Here reading first the Issue Creation Policy.

Git Workflow Policy

  1. Direct push to Master is not allowed.
  2. Pull Requests to Master are not allowed.
  3. Usually, commits and pull requests should be done on Dev branch. If you have any doubt, don't hesitate to ask first.
  4. Temporary branches may be existing for specific features, be pretty sure that the branch you are going to commit on is the right one. Ask first if you have any doubt.
  5. Any branch will be finally merged to Dev, there it will be reviewed and tested deeply before being merged to Master.
  6. All merges from Dev to Master are a new airgeddon release. This merges to Master will be performed and reviewed exclusively by v1s1t0r/OscarAkaElvis.

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: v1s1t0r.1s.h3r3@gmail.com
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: