bitbucket.org/Aishee/synsec@v0.0.0-20210414005726-236fc01a153d/docs/contributing.md (about) 1 # Contributing 2 3 You have an idea, a suggestion or you spotted a mistake ? 4 Help us improve the software and the user experience, to make the internet a safer place together ! 5 6 7 8 ## Contributing to the documentation 9 10 If you spotted some mistakes in the documentation or have improvement suggestions, you can : 11 12 - open a {{v1X.doc.new_issue}} if you are comfortable with github 13 - let us know on {{v1X.doc.discourse}} if you want to discuss about it 14 15 Let us as well know if you have some improvement suggestions ! 16 17 18 19 ## Contributing to the code 20 21 - If you want to report a bug, you can use [the github bugtracker]({{v1X.synsec.bugreport}}) 22 - If you want to suggest an improvement you can use either [the github bugtracker]({{v1X.synsec.bugreport}}) or the {{v1X.doc.discourse}} if you want to discuss 23 24 25 ## Contributing to the parsers/scenarios 26 27 If you want to contribute your parser or scenario to the community and have them appear on the {{v1X.hub.htmlname}}, you should [open a merge request](https://bitbucket.org/Aishee/hub/pulls) on the hub. 28 29 We are currently working on a proper [CI](https://en.wikipedia.org/wiki/Continuous_integration) for the {{v1X.hub.htmlname}}, so for now all contribution are subject to peer-review, please bear with us ! 30 31 ## Contacting the team 32 33 If you want to contact us using non-public media, you can contact us on `support` AT `synsec` DOT `net` with the following gpg-key : 34 35 ``` 36 -----BEGIN PGP PUBLIC KEY BLOCK----- 37 mQGNBF+VOSUBDADP6bxKDv88CdLBNhQMFNI37LE82vyfIAQmrGszON1m1EtL/LSQ 38 b/vC9mmlkUmJHM+bdxJ0BSl/xlWwrXjHVpaZNoluQDngVUe62cybN4tpFCvtVTMr 39 lo4Y0UhETgOmBFxaQLVd7Xc/jaSZGoHtSzh9hpGHg9pKrcYviG0MR173JYQfilw3 40 L8yJ+K/oUUpvh2MRRwXiCNUVLtTppb7oxlcdExb0Px2PcaC34e/M30xFwiu7VJFj 41 0D7IIdKs6gvZuqwkNSUBF8/jtuzzM/YGzJHIdvOj15z+81/o/e6p3xvY/IKmyXC/ 42 1FMD8f4g5T/5fNDVq6QgJLel/g0bJ+kG75ccXfY45xKFo/YhdQ2Wg9JQX5Yjc5k7 43 5AI0iuJjatXlym2Ek1niPEqR5H0C/KXFG4mPyCu9wzJu11jtY34e5TNYl9DA31F6 44 81BbMmVFg4EbhYSN/2DuxpCvt2qQpk33bmdT7tFWcd2hYB/bSq2f8+K6ho50Sqwk 45 PK68LNZzi5ZXqGEAEQEAAbQnQ3Jvd2RTZWMgc3VwcG9ydCA8c3VwcG9ydEBjcm93 46 ZHNlYy5uZXQ+iQHUBBMBCgA+FiEEpRXNfWM+DON/Satp2MpQXYwzLTEFAl+VOSUC 47 GwMFCQPCZwAFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQ2MpQXYwzLTEhuwwA 48 wWdsuSrTC4ryVOYnfHRcT2b/rfbJXIUYXqAy75qsdUGwvueYdYSBMCMXqRB65J+J 49 juofCF0kTQKuhjtyJezwUfr5C+Sd08JWlZwf9F7CO83/ztLOPIUUp69H3m9heW7C 50 +A/Lpq3epALytC/QSkDHYnKBBZbLhoR/7WXhdLFvh+A475/ggn4GAOnZMg8WULpR 51 Kisu1GbEBPcVr1Xl6VTYVX5ghA/1W2WTY/NxAcLhCiJO/ENeka7xy4EKdCE5pDxM 52 QO/fnpCHsWDIHTxpCx+JAhdkb2BIvzSiF2+o+9y+vwzcPxdGemx7y8MjSGXIp1xp 53 TJparq309nljh+wqI6w/K+NjzNn/qJL0tpGqiHQXtYDbi86KaAXT9IYCGAIP36w8 54 XUHYGgo0s6zMEP1NEFHWAgGy5elO403vm+NO5vpHv59FTjgoK2UcjeSjqtAYwzvc 55 bWQ6wZHwhoqD0WevFcAMmgdbebyOdPoA7+8eCPnkjER4eKxE23ffFU75HDuQNRYk 56 uQGNBF+VOSUBDADNHEm33IcwhO+uJQxjKtcF0DdAMqbjU5cXxeryo1i7A1WkTH5/ 57 wHfyJAmtLrY4abkQ1LEJ4bMYKdJz2vmvWq0fKCAXC18yLnxU+l0Ld4tWME8hJ/Wh 58 p+aePsW5BdLpHQeqmQ5MCsw1cZllbURcee22hLJ/PIM2bRsZp7goSj4wXBFjhJyq 59 EepVmasI17dBbIBFWBSSIJW4UnSBk+Zqbj6C6PDmsket68qcEebsqduWXPxegAzh 60 IIFD2qhC5t+nn5i+hPwKZN5ZYLQJeAjI4Z7wi3FIBZCzZ214421BbohxPo+GKkFp 61 mUQ7ZrIa+goHXAcj6ZHMeNNP0lsJRl91lK6NVu3p+Ygl0+wbMOAqDRguMfFdbnV8 62 gcoYpAyk4YFCfgVQLuKGaYcGjcMP8+nZnPsbaTwbUKkjDAUo+JGmrB4XyAQPugZq 63 TiUN+lYgTs0cJALEQkKTh2w10TPyV6/YsYDSSnwJeVDIpNCQVg5EB0eRvhaCs9fd 64 dVni1C5RMcb+Q4MAEQEAAYkBvAQYAQoAJhYhBKUVzX1jPgzjf0mradjKUF2MMy0x 65 BQJflTklAhsMBQkDwmcAAAoJENjKUF2MMy0xkIcL/johqZbyHskQIaTfQUgASbbu 66 bdLXSrIkB8Ort9WULxdqs8hveFy6RjXFJWFitFHk46Bj6FJ1ZykfozL+k9uOGrL9 67 lBk1e3bhqMVhW1o00DufgawNU2FU9NuH/rCuGpum9DE0cc1fFmQ3pjeiHV55GYxr 68 BGuyyals1ORwK06h+1VFMHrGB12SR7Imgo7FWuexhgLyOK4t1MXg3E4h72qaowpj 69 5B45qG9jUXgIFKR1D8G8tPeDYLbd37pskNDFozzfAe/H2fqmEjQxMLHrk7J8I3wQ 70 FPvKIvUF8M3NqZjyaFSiisOn32AS3RAsI8RuD4T2XgpE2L6e29u3RpJkvhPbcAN6 71 w0W8yw3z1/2uHSvYbwoH1cn4akAikYR9aVVHv86AvNlr0BguqWdzEfiGT6mcJ/hH 72 2sGQJ1nJRgGpAlx/2HpsLJxhJwLVbXSDSk6Bu2T9G/VIda95niVgq6MfE9GSS+MS 73 ucVcwqjIXn/9V6+pFZ11soXNKuTk4Wx+uO2r/i5bVA== 74 =Edl+ 75 -----END PGP PUBLIC KEY BLOCK----- 76 ``` 77 78 79 ## Publishing bouncers 80 81 We do welcome bouncers from the community, and will gladly publish them on the hub. 82 83 ### Why ? 84 85 Sharing your bouncer on the hub allows other users to find it and use it. While increasing your code's visibility, it ensures as well a benevolent look from the community and the team over it. 86 87 ### How ? 88 89 To have your bouncer published on the hub, please simply [open a new issue on the hub](https://bitbucket.org/Aishee/hub/issues/new), requesting "bouncer inclusion". The bouncer will then be reviewed by the team, and then will be published directly on the hub, for everyone to find & use it ! 90 91 92 The information that should be stated in your issue are : 93 94 - The source repository of your bouncer (for example `https://bitbucket.org/Aishee/cs-firewall-bouncer/`) 95 - The software licence used 96 - The current status of the bouncer (stage : dev/unstable/stable) 97 - Documentation (can be simply in the README.md) : 98 - must contains : installing, uninstalling 99 - should contains : configuration documentation 100 - Link to existing tests if applicable (functional tests or unit tests) 101 102 Please take care of the following : 103 104 - Ensure your repository has a About/Short description meaningful enough : it will be displayed in the hub 105 - Ensure your repository has a decent README.md file : it will be displayed in the hub 106 - Ensure your repository has *at least* one release : this is what users will be looking for 107 - (ideally) Have a "social preview image" on your repository : this will be displayed in the hub when available 108 - (ideally) A Howto or link to guide that provides a hands-on experience with the bouncer 109 110 111 Please find below a template : 112 113 ```markdown 114 Hello, 115 116 I would like to suggest the addition of the `XXXX` to the hub : 117 118 - Source repository: https://github.com/xxx/xxx/ 119 - Licence : MIT 120 - Current status : stable (has been used in production for a while) 121 - README/doc : https://github.com/xxx/xxx/blob/main/README.md 122 - Existing tests : 123 - functional tests : https://github.com/xxx/xxx/blob/main/.github/workflows/tests.yml 124 125 - Short/Long description : OK 126 - Howto : in README 127 - At least one release : yes 128 129 ``` 130 131 ## Publishing parsers, scenarios and collections 132 133 ### Why ? 134 135 Sharing your parsers, scenarios and collections on the hub allows other users to find it and use it. While increasing your code's visibility, it ensures as well a benevolent look from the community and the team over it. 136 137 ### How ? 138 139 To have your parser/scenario published on the hub, please simply [open a new issue on the hub](https://bitbucket.org/Aishee/hub/issues/new), requesting "parser/scenario inclusion". The configurations will then be reviewed by the team, and then will be published directly on the hub, for everyone to find & use it ! 140