Skip to content

Latest commit

 

History

History
34 lines (19 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

34 lines (19 loc) · 2.14 KB

Contributing to CyberSoc Kali

Thanks for wanting to contribute to our repo! Here are some guidelines we ask you to follow:

Issues

If you find any issues with the ISO, please open an issue. This will allow us to fix the issue as soon as possible. Please be as descriptive as possible in your issue, as this will help us to reproduce the problem

Feature requests

If there is a change you would like to see made to anything in this repo (the package list, the configuration of the image, or the build process), please open an issue requesting this.

Pull requests

If you feel comfortable working on a change or fix yourself, please feel free to send us a pull request.

We suggest that you open an issue discussing the change, to give us the opportunity to make comments on the change before you start work, as we may decide to reject changes, and we do not want people wasting their time. We will still review pull requests that do not have a related issue, but please be aware that we may reject your change.

Note that this does not mean you should spam the issue tracker just to meet this suggestion. If you have already written your change, or if it is so small that the amount of effort is negligible, an issue is not needed.

Commit guidelines

  • Please give commits descriptive messages.
    • For example, if a commit adds the package vim, a suitable commit message would be Added pacakge vim, not Updated kali-config/variant-cybersoc/package-lists/kali.list.chroot.
  • Please do not use too many commits.
    • For example, if a change or fix requires changes in 3 files, these should all be in one commit, with a message describing the entire fix, rather than three separate commits.

If your pull request does not meet these commit guidelines, we may ask you to amend your commit history (see amending and rebasing) before we accept it.


Licensing

All contributions to this repository will be licensed under the GNU GPL.