mirror of
https://github.com/lunchcat/sif.git
synced 2025-12-12 07:40:39 -08:00
Update README.md and add CONTRIBUTING, COC
This commit is contained in:
Sol Fisher Romanoff
27
CODE_OF_CONDUCT.md
Normal file
27
CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# sif Code of Conduct
|
||||
|
||||
The sif project aims to be **enjoyable** for anyone to participate in, regardless of their identity or level of expertise. To achieve this, the community must create an environment which is **safe** and **equitable**; the following guidelines have been created with these goals in mind.
|
||||
|
||||
1. **This is not a professional space.** Individuality is not only welcome, but encouraged. Professionalism asks marginalized individuals to censor themselves, and perform their identity in an inauthentic, unchallenging manner, which caters solely to those in power (namely rich, white, cisgender, heterosexual men). Seeking professionalism is *antithetical* to the goal of equity, and thus, these guidelines reject it.
|
||||
- Attempting to suppress self-expression or non-harmful speech is not acceptable for any reason.
|
||||
- There will be queers, punks, femboys, drag queens, furries, hackers, kinksters, and all sorts of other people here. And the project will reflect that. If you don't like this, consider looking for Free Software projects [elsewhere](https://loose-files.keithhacks.cyou/img/trashcan.jpg).
|
||||
|
||||
2. **Treat individuals with respect.** Differing experiences and viewpoints deserve to be respected, and bigotry and harassment are not tolerated under any circumstances.
|
||||
- Individuals should never be made to feel unsafe or unvalued due to their age, gender, sexuality, race, ethnicity, disability, religion, appearance, education, level of expertise, or other factors.
|
||||
- Behaviour that is harmful in nature should be addressed and corrected *regardless of intent*.
|
||||
- Respect personal boundaries and ask for clarification whenever they are unclear.
|
||||
- (Obviously, hate does not count as merely a "differing viewpoint", because it is harmful in nature.)
|
||||
|
||||
3. **Be understanding of differences in communication.** Not everyone is aware of unspoken social cues, and speech that is not intended to be offensive should not be treated as such simply due to an atypical manner of communication.
|
||||
- Somebody who speaks bluntly is not necessarily rude, and somebody who swears a lot is not necessarily volatile.
|
||||
- Try to confirm your interpretation of their intent rather than assuming bad faith.
|
||||
|
||||
4. **"Uncomfortable" does not mean "unsafe".** In an ideal world, the community would be safe, equitable, enjoyable, *and* comfortable for all members at all times. Unfortunately, this is not always possible in reality.
|
||||
- Safety and equity will be prioritized over comfort whenever it is necessary to do so.
|
||||
- Weaponizing one's own discomfort to deflect accountability or censor an individual (e.g. "white fragility") is a form of discriminatory conduct.
|
||||
|
||||
5. **Let people grow from their mistakes.** Nobody is perfect; even the most well-meaning individual can do something hurtful. Everyone should be given a fair opportunity to explain themselves and correct their behaviour. Portraying someone as inherently malicious prevents improvement and shifts focus away from the *action* that was problematic.
|
||||
- Avoid bringing up past events that do not accurately reflect an individual's current actions or beliefs. (This is, of course, different from providing evidence of a recurring pattern of behaviour.)
|
||||
|
||||
---
|
||||
This document was created by ~keith as part of punks default repository template, and is licensed under CC-BY-SA 4.0. The original template is here: <https://bytes.keithhacks.cyou/keith/default-template>
|
||||
59
CONTRIBUTING.md
Normal file
59
CONTRIBUTING.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# Contributing
|
||||
|
||||
Thank you for taking the time to contribute to sif! All contributions are valued, and no contribution is too small or insignificant.
|
||||
If you want to contribute but don't know where to start, worry not; there is no shortage of things to do.
|
||||
Even if you don't know any Go, don't let that stop you from trying to contribute! We're here to help.
|
||||
|
||||
*By contributing to this repository, you agree to adhere to the sif [Code of Conduct](https://github.com/pushfs/sif/blob/main/CODE_OF_CONDUCT.md). Not doing so may result in a ban.*
|
||||
|
||||
## How can I help?
|
||||
|
||||
Here are some ways to get started:
|
||||
- Have a look at our [issue tracker](https://github.com/pushfs/sif/issues).
|
||||
- If you've encountered a bug, discuss it with us, [report it](#reporting-issues).
|
||||
- Once you've found a bug you believe you can fix, open a [pull request](#contributing-code) for it.
|
||||
- Alternatively, consider [packaging sif for your distribution](#packaging).
|
||||
|
||||
If you like the project, but don't have time to contribute, that's okay too! Here are other ways to show your appreciation for the project:
|
||||
- Use sif (seriously, that's enough)
|
||||
- Star the repository
|
||||
- Share sif with your friends
|
||||
- Support us on Liberapay (thank you!)
|
||||
|
||||
## Reporting issues
|
||||
|
||||
If you believe you've found a bug, or you have a new feature to request, please hop on the [IRC channel](https://web.libera.chat/gamja/?channels=#sif) first to discuss it.
|
||||
This way, if it's an easy fix, we could help you solve it more quickly, and if it's a feature request we could workshop it together into something more mature.
|
||||
|
||||
When opening an issue, please use the search tool and make sure that the issue has not been discussed before. In the case of a bug report, run sif with the `-d/-debug` flag for full debug logs.
|
||||
|
||||
## Contributing code
|
||||
|
||||
### Development
|
||||
|
||||
To develop sif, you'll need version 1.20 or later of the Go toolchain. After making your changes, run the program using `go run ./cmd/sif` to make sure it compiles and runs properly.
|
||||
|
||||
*Nix users:* the repository provides a flake that can be used to develop and run sif. Use `nix run`, `nix develop`, `nix build`, etc. Make sure to run `gomod2nix` if `go.mod` is changed.
|
||||
|
||||
### Submitting a pull request
|
||||
|
||||
When making a pull request, please adhere to the following conventions:
|
||||
|
||||
- sif adheres to the Go style guidelines. Always format your gode with `gofmt`.
|
||||
- When adding/removing imports, make sure to use `go mod tidy`, and then run `gomod2nix` to generate the Nix-readable module list.
|
||||
- Set `git config pull.rebase true` to rebase commits on pull instead of creating ugly merge commits.
|
||||
- Title your commits in present tense, in the imperative style.
|
||||
- You may use prefixes like `feat`, `fix`, `chore`, `deps`, etc.
|
||||
**Example:** `deps: update gopkg.in/yaml.v3 to v3.0.1`
|
||||
- You may use prefixes to denote the part of the code changed in the commit.
|
||||
**Example:** `pkg/scan: ignore 3xx redirects`
|
||||
- If not using a prefix, make sure to use sentence case.
|
||||
**Example:** `Add nuclei template parsing support`
|
||||
- If applicable, provide a helpful commit description, listing usage notes, implementation details, and tasks that still need to be done.
|
||||
|
||||
If you have any questions, feel free to ask around on the IRC channel.
|
||||
|
||||
## Packaging
|
||||
|
||||
We'd love it if you helped us bring sif to your distribution.
|
||||
The repository provides a Makefile for building and packaging sif for any distro; consult your distribution's documentation for details.
|
||||
40
README.md
40
README.md
@@ -1,23 +1,25 @@
|
||||
```
|
||||
_____________
|
||||
__________(_)__ __/
|
||||
__ ___/_ /__ /_
|
||||
_(__ )_ / _ __/
|
||||
/____/ /_/ /_/
|
||||
```
|
||||
*a blazing-fast pentesting (recon/exploitation) suite written in Go 🐾*
|
||||
|
||||
<div align="center">
|
||||
## Features
|
||||
- 📂 Directory/file fuzzing/scanning
|
||||
- 📡 DNS subdomain enumeration
|
||||
- 🐾 Common Web scanning
|
||||
- 🖥️ Port/service scanning
|
||||
- 🦠 Vulnerability scanning
|
||||
- Support for pre-existing nuclei templates
|
||||
- Metasploit emulation for execution
|
||||
- 🔎 Automated Google dorking
|
||||
- 💘 Shodan integration
|
||||
|
||||
<img src="assets/banner.png">
|
||||
## Contributing and support
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
## Contributing / Support
|
||||
|
||||
Contributions are always welcome!
|
||||
|
||||
See `contributing.md` for ways to get started.
|
||||
|
||||
You can join us on different platforms
|
||||
|
||||
- IRC: [#sif: libera.chat](https://web.libera.chat/gamja/?channels=#sif)
|
||||
|
||||
## Authors
|
||||
|
||||
- [@pushfs](https://www.github.com/pushfs)
|
||||
- [@solfisher](https://www.github.com/solfisher)
|
||||
Please join [#sif:irc.libera.chat](https://web.libera.chat/gamja/?channels=#sif) to discuss sif development and to ask questions. Feel free to open an issue on GitHub requesting an addition to sif or asking for help with an issue.
|
||||
|
||||
Contributions are welcome! Make sure to read `CONTRIBUTING.md` before submitting a pull request.
|
||||
|
||||
Reference in New Issue
Block a user