Skip to content

Development information

Ekultek edited this page Jul 14, 2018 · 17 revisions

Development of AutoSploit

AutoSploit is developed by a small team of security enthusiasts, with a passion for breaking things and learning how they work. Along with that we thrive on the contributions of fellow developers and security enthusiasts. We at the team enjoy long walks on the beach, breaking into random networks, making security professionals crap their pants, and causing mass mania in the media.

If for any reason you need to contact one of the team members, you can do so by emailing us at autosploit-dev-team@protonmail.com, we will ensure that your conversation is confidential and on a need to know basis, once you have sent them email please allow up to 48 hours for us to get into contact with you. You can also contact us on Twitter at @Real__Vector or @stay__salty. Furthermore you can join our discord server and chat with us here NOTE: this discord server link is expired to be invited create an issue and ask

Note: If for any reason one of the team does not contact you within 48 hours, please create an issue and let us know you have emailed us. We apologize for any delays that may happen, but we, of course, are busy most of the time

Contributing

All contributions to Autosploit are not only welcomed, but highly appreciated, please keep in mind the following while making a pull request:

  • Each request should make at least on logical change
  • All contributions should be forked from the dev-beta branch
  • Each request will need to be reviewed before merged, if anything seems weird we will either fix it or ask you to fix it for us
  • If you have multiple pushes in one request, please squash them together (or we will before we merge)
  • All pull requests that are merged are provided under the same license as the program is, keep the following in mind;

By submitting code contributions to AutoSploit via Git pull request or other, checking them into the AutoSploit's source code repository, it is understood (unless you specify otherwise) that you are offering the AutoSploit copyright holders the unlimited, non-exclusive right to reuse, modify, and re-license the code. This is important because the inability to re-license code has caused devastating problems for other software projects (such as KDE and NASM). If you wish to specify special license conditions of your contributions, just say so when you send them.

To get started making a contribution please do the following:

  • Fork the repository using the fork button
  • git clone https://github.com/<YOUR-NAME>/AutoSploit.git -b dev-beta
  • Edit the code to your liking
  • After editing git branch <YOUR-BRANCH-NAME> && git checkout <YOUR-BRANCH-NAME>
  • Add your commits and comment them
  • git push --set-upstream origin <YOUR-BRANCH>
  • Open a pull request
  • Wait for us to check it out

Contribution standards

While contributing you should keep our standards in mind:

  • All classes should be named in UpperCamelCase
  • Constants should all be done in UPPERCASE
  • Functions should all be done in lower_case
  • All functions should be separated by 2 spaces, follow PEP8 standards!
  • Global variables are frowned upon unless needed specifically
  • Do not use from foo import * instead import everything between parentheses IE;
from foo import (
    1,
    2,
    ...
)
  • If you like OOP feel free to implement it. But keep in mind, simple is always better
  • Try to keep your contribution down to under 300 LoC (lines of code), if you need to do over 300, that's fine, just try to keep it under 300
  • Translations of the README are acceptable and very welcomed
  • Make sure you read the code and understand what works with everything, all contributions will be tested thoroughly and if there are any tracebacks in the tests, your contribution will be closed as invalid
  • Comment your code! We have a lot of contributors and we want it to be easy for everyone to follow what's going on

We of course have a code of conduct for development and legal purposes. Anybody found violating the code of conduct will have all their pull requests ignored, and all their issues closed with a wontfix flag. Please be respectful to one another when you are developing;

Contributor Covenant Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members Examples of unacceptable behavior by participants include:
  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at autosploit-dev-team@protonmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by the project's owner and administrator NullArray.

Attribution

This Code of Conduct is adapted from the Contributor Covenant homepage (listed below), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html homepage: https://www.contributor-covenant.org

Please keep this code of conduct in mind before you contribute to the development.

You can’t perform that action at this time.