mirror of
https://github.com/anotherhadi/github-recon.git
synced 2026-10-05 10:58:25 +02:00
@@ -0,0 +1,10 @@
|
||||
# Contributing
|
||||
|
||||
Everybody is invited and welcome to contribute to this repo. There is a lot to do... Check the issues!
|
||||
|
||||
The process is straight-forward.
|
||||
|
||||
- Read [How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews) by Kubernetes. (but skip step 0 and 1)
|
||||
- [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) this repo.
|
||||
- Write your changes (bug fixe, new feature, issues fix, ...).
|
||||
- Create a Pull Request against the main branch.
|
||||
@@ -47,6 +47,8 @@ go get github.com/anotherhadi/gh-recon
|
||||
|
||||
### With Nix/NixOS
|
||||
|
||||
<details>
|
||||
<summary>Click to expand</summary>
|
||||
**From anywhere (using the repo URL):**
|
||||
|
||||
```bash
|
||||
@@ -69,6 +71,8 @@ environment.systemPackages = with pkgs; [ # or home.packages
|
||||
];
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
@@ -77,8 +81,6 @@ gh-recon --username TARGET_USER [--token YOUR_TOKEN]
|
||||
|
||||
### Flags
|
||||
|
||||
- `--token`: Personal Access Token (optional but recommended)
|
||||
|
||||
```txt
|
||||
-deep
|
||||
Enable deep scan (clone repos, regex search, analyse licenses, etc.)
|
||||
@@ -104,10 +106,6 @@ gh-recon --email [email protected] --token ghp_ABC123...
|
||||
gh-recon --username anotherhadi --json output.json --deep
|
||||
```
|
||||
|
||||
## Todo
|
||||
## Contributing
|
||||
|
||||
Feel free to contribute!
|
||||
|
||||
**Todo:**
|
||||
|
||||
- Find and parse licenses
|
||||
Feel free to contribute! See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
|
||||
|
||||
Reference in New Issue
Block a user