From d9732bfd56d5830039777be7b3eafc041087b508 Mon Sep 17 00:00:00 2001 From: Adhithya <33666474+radhi1991@users.noreply.github.com> Date: Tue, 25 Jun 2024 12:22:11 +0530 Subject: [PATCH 1/5] Create roadmap.md Adding Roadmap file --- roadmap.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 roadmap.md diff --git a/roadmap.md b/roadmap.md new file mode 100644 index 0000000..1354440 --- /dev/null +++ b/roadmap.md @@ -0,0 +1,44 @@ +# xGitGuard Roadmap + +## How to Use This Roadmap +This document serves as a comprehensive guide to the prioritized objectives of the xGitGuard project. It offers insight into the direction of the project, aiding contributors in understanding its trajectory. It also helps contributors determine whether their contributions align with the project's long-term goals. While a feature may not be listed here, it doesn't imply automatic refusal of a patch (except for "frozen features" mentioned below). We welcome patches for new features and encourage innovation. However, please be aware that such patches may take longer to review. + +## How Can I Contribute? +Short-term objectives are documented in the wiki (link to be added later) and outlined in issues. Our aim is to distribute the workload in a manner that enables anyone to contribute. Please comment on issues to express your interest and avoid duplicating efforts. + +## How Can I Propose a Feature for the Roadmap? +The roadmap process is a new initiative for xGitGuard, as we begin to structure and document our project objectives. Our immediate goal is to enhance transparency and collaborate with our community to focus on prioritized topics. While we aim to introduce a process for proposing topics to the roadmap in the near future, we're not there yet. + +# Feature Classification + +## Adhoc Scan ---> https://github.com/Comcast/xGitGuard/issues/24 + +| Feature | Description | Status | Developer (GitHub ID) | +|---------------------------|---------------------------------------------------------|--------|-----------------------| +| Targeted repository scanning | Enable xGitGuard to scan user specified repositories for secrets | ✅ Done | [preethid03](https://github.com/preethid03) | +| Targeted organization scanning | Enable xGitGuard to scan user specified organization for secrets | ✅ Done | [preethid03](https://github.com/preethid03) | +| Filtering archived repositories | Exclude archived repositories from scanning | ✅ Done | [preethid03](https://github.com/preethid03) | +| Filtering forked repositories | Exclude forked repositories from scanning | ✅ Done | [preethid03](https://github.com/preethid03) | +| Custom keyword search | Search for specific keywords within repositories | ✅ Done | [preethid03](https://github.com/preethid03) | + +## File Scanner ---> https://github.com/Comcast/xGitGuard/issues/32 + +| Feature | Description | Status | Developer (GitHub ID) | +|---------------------------|---------------------------------------------------------|--------|-----------------------| +| Directory scanning | Enable scanning user specified directories for secrets | ⏳ WIP | [](https://github.com/developer6) | +| Individual file scanning | Enable scanning user specified individual files for secrets | ⏳ WIP | [](https://github.com/developer7) | + +## ML Integration + +| Feature | Description | Status | Developer (GitHub ID) | +|---------------------------|---------------------------------------------------------|--------|-----------------------| +| Training and building models using BERT | Train ML models for secret detection using BERT | 🚧 To Do | [](https://github.com/developer8) | +| Integrating BERT into scanners | Integrating trained BERT model into the xGitGuard scanner | 🚧 To Do | [](https://github.com/developer9) | + +## Pre-commit Hook + +| Feature | Description | Status | Developer (GitHub ID) | +|---------------------------|---------------------------------------------------------|--------|-----------------------| +| Multi-language package manager | Manage code checks and linters before commits | 🚧 To Do | [](https://github.com/preethid030) | +| Automatic installation of code linters | Install necessary tools for code review | 🚧 To Do | [](https://github.com/preethid031) | +| Run code linters and checks | Ensure code quality before committing changes | 🚧 To Do | [](https://github.com/preethid032) | From 74b113229eccab89da181adbf965b07482bb03ce Mon Sep 17 00:00:00 2001 From: Adhithya <33666474+radhi1991@users.noreply.github.com> Date: Tue, 25 Jun 2024 12:56:05 +0530 Subject: [PATCH 2/5] Update roadmap.md Updated roadmap --- roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roadmap.md b/roadmap.md index 1354440..f274445 100644 --- a/roadmap.md +++ b/roadmap.md @@ -28,7 +28,7 @@ The roadmap process is a new initiative for xGitGuard, as we begin to structure | Directory scanning | Enable scanning user specified directories for secrets | ⏳ WIP | [](https://github.com/developer6) | | Individual file scanning | Enable scanning user specified individual files for secrets | ⏳ WIP | [](https://github.com/developer7) | -## ML Integration +## ML Integration ---> https://github.com/Comcast/xGitGuard/issues/32 | Feature | Description | Status | Developer (GitHub ID) | |---------------------------|---------------------------------------------------------|--------|-----------------------| From d8dd494ab2f9e0b26662e10527165df477d4ac8d Mon Sep 17 00:00:00 2001 From: "R.Adhithya" <33666474+radhi1991@users.noreply.github.com> Date: Mon, 8 Jul 2024 17:18:14 +0530 Subject: [PATCH 3/5] Update roadmap.md --- roadmap.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/roadmap.md b/roadmap.md index f274445..fe75bf6 100644 --- a/roadmap.md +++ b/roadmap.md @@ -17,16 +17,14 @@ The roadmap process is a new initiative for xGitGuard, as we begin to structure |---------------------------|---------------------------------------------------------|--------|-----------------------| | Targeted repository scanning | Enable xGitGuard to scan user specified repositories for secrets | ✅ Done | [preethid03](https://github.com/preethid03) | | Targeted organization scanning | Enable xGitGuard to scan user specified organization for secrets | ✅ Done | [preethid03](https://github.com/preethid03) | -| Filtering archived repositories | Exclude archived repositories from scanning | ✅ Done | [preethid03](https://github.com/preethid03) | -| Filtering forked repositories | Exclude forked repositories from scanning | ✅ Done | [preethid03](https://github.com/preethid03) | -| Custom keyword search | Search for specific keywords within repositories | ✅ Done | [preethid03](https://github.com/preethid03) | -## File Scanner ---> https://github.com/Comcast/xGitGuard/issues/32 +## File Scanner | Feature | Description | Status | Developer (GitHub ID) | |---------------------------|---------------------------------------------------------|--------|-----------------------| -| Directory scanning | Enable scanning user specified directories for secrets | ⏳ WIP | [](https://github.com/developer6) | -| Individual file scanning | Enable scanning user specified individual files for secrets | ⏳ WIP | [](https://github.com/developer7) | +| Filtering archived repositories | Exclude archived repositories from scanning | 🚧 To Do | [](https://github.com/developer8) | +| Filtering forked repositories | Exclude forked repositories from scanning | 🚧 To Do | [](https://github.com/developer8) | +| Custom keyword search | Search for specific keywords within repositories | 🚧 To Do | [](https://github.com/developer8) | ## ML Integration ---> https://github.com/Comcast/xGitGuard/issues/32 @@ -42,3 +40,5 @@ The roadmap process is a new initiative for xGitGuard, as we begin to structure | Multi-language package manager | Manage code checks and linters before commits | 🚧 To Do | [](https://github.com/preethid030) | | Automatic installation of code linters | Install necessary tools for code review | 🚧 To Do | [](https://github.com/preethid031) | | Run code linters and checks | Ensure code quality before committing changes | 🚧 To Do | [](https://github.com/preethid032) | + + From 3ae4a57df25d06613f0127738a7a6ecc3610a61a Mon Sep 17 00:00:00 2001 From: "R.Adhithya" <33666474+radhi1991@users.noreply.github.com> Date: Mon, 8 Jul 2024 21:15:42 +0530 Subject: [PATCH 4/5] Update roadmap.md Making the requested changes --- roadmap.md | 75 +++++++++++++++++++++++++++++++++++------------------- 1 file changed, 49 insertions(+), 26 deletions(-) diff --git a/roadmap.md b/roadmap.md index fe75bf6..d3faa0e 100644 --- a/roadmap.md +++ b/roadmap.md @@ -1,44 +1,67 @@ + # xGitGuard Roadmap ## How to Use This Roadmap -This document serves as a comprehensive guide to the prioritized objectives of the xGitGuard project. It offers insight into the direction of the project, aiding contributors in understanding its trajectory. It also helps contributors determine whether their contributions align with the project's long-term goals. While a feature may not be listed here, it doesn't imply automatic refusal of a patch (except for "frozen features" mentioned below). We welcome patches for new features and encourage innovation. However, please be aware that such patches may take longer to review. +This document serves as a comprehensive guide to the prioritized objectives of the xGitGuard project. It offers insight into the direction of the project, aiding contributors in understanding its trajectory. It also helps contributors determine whether their contributions align with the project's long-term goals. -## How Can I Contribute? -Short-term objectives are documented in the wiki (link to be added later) and outlined in issues. Our aim is to distribute the workload in a manner that enables anyone to contribute. Please comment on issues to express your interest and avoid duplicating efforts. +While a feature may not be listed here, it doesn't imply automatic refusal of a patch (except for "frozen features" mentioned below). We welcome patches for new features and encourage innovation. However, please be aware that such patches may take longer to review. -## How Can I Propose a Feature for the Roadmap? -The roadmap process is a new initiative for xGitGuard, as we begin to structure and document our project objectives. Our immediate goal is to enhance transparency and collaborate with our community to focus on prioritized topics. While we aim to introduce a process for proposing topics to the roadmap in the near future, we're not there yet. +--- -# Feature Classification +## Feature Classification -## Adhoc Scan ---> https://github.com/Comcast/xGitGuard/issues/24 +### Adhoc Scan +| Feature | Description | Status | Developer (GitHub ID) | +|----------------------------------|--------------------------------------------------|-----------|------------------------------| +| [🎯 Targeted repository scanning](https://github.com/Comcast/xGitGuard/issues/24) | Scan user specified repositories for secrets | ✅ Done | [preethid03](https://github.com/preethid03) | +| [🎯 Targeted organization scanning](https://github.com/Comcast/xGitGuard/issues/24) | Scan user specified organization for secrets | ✅ Done | [preethid03](https://github.com/preethid03) | -| Feature | Description | Status | Developer (GitHub ID) | -|---------------------------|---------------------------------------------------------|--------|-----------------------| -| Targeted repository scanning | Enable xGitGuard to scan user specified repositories for secrets | ✅ Done | [preethid03](https://github.com/preethid03) | -| Targeted organization scanning | Enable xGitGuard to scan user specified organization for secrets | ✅ Done | [preethid03](https://github.com/preethid03) | +--- -## File Scanner +### File Scanner | Feature | Description | Status | Developer (GitHub ID) | |---------------------------|---------------------------------------------------------|--------|-----------------------| -| Filtering archived repositories | Exclude archived repositories from scanning | 🚧 To Do | [](https://github.com/developer8) | -| Filtering forked repositories | Exclude forked repositories from scanning | 🚧 To Do | [](https://github.com/developer8) | -| Custom keyword search | Search for specific keywords within repositories | 🚧 To Do | [](https://github.com/developer8) | +| 📁 Directory scanning | Enable scanning user specified directories for secrets | ⏳ WIP | [](https://github.com/developer6) | +| 📁 Individual file scanning | Enable scanning user specified individual files for secrets | ⏳ WIP | [](https://github.com/developer7) | -## ML Integration ---> https://github.com/Comcast/xGitGuard/issues/32 -| Feature | Description | Status | Developer (GitHub ID) | -|---------------------------|---------------------------------------------------------|--------|-----------------------| -| Training and building models using BERT | Train ML models for secret detection using BERT | 🚧 To Do | [](https://github.com/developer8) | -| Integrating BERT into scanners | Integrating trained BERT model into the xGitGuard scanner | 🚧 To Do | [](https://github.com/developer9) | -## Pre-commit Hook +--- -| Feature | Description | Status | Developer (GitHub ID) | -|---------------------------|---------------------------------------------------------|--------|-----------------------| -| Multi-language package manager | Manage code checks and linters before commits | 🚧 To Do | [](https://github.com/preethid030) | -| Automatic installation of code linters | Install necessary tools for code review | 🚧 To Do | [](https://github.com/preethid031) | -| Run code linters and checks | Ensure code quality before committing changes | 🚧 To Do | [](https://github.com/preethid032) | +### ML Integration ---> [GitHub Issues](https://github.com/Comcast/xGitGuard/issues/32) +| Feature | Description | Status | Developer (GitHub ID) | +|----------------------------------|--------------------------------------------------|-----------|------------------------------| +| 🤖 Training ML models using BERT | Train models for secret detection using BERT | 🚧 To Do | [](https://github.com/developer8) | +| 🤖 Integrating BERT into scanners | Integrate BERT model into xGitGuard scanner | 🚧 To Do | [](https://github.com/developer9) | + +--- + +### Pre-commit Hook +| Feature | Description | Status | Developer (GitHub ID) | +|----------------------------------|--------------------------------------------------|-----------|------------------------------| +| 🛠️ Multi-language package manager| Manage code checks and linters before commits | 🚧 To Do | [](https://github.com/) | +| 🛠️ Automatic installation of linters| Install necessary tools for code review | 🚧 To Do | [](https://github.com/) | +| 🛠️ Run code linters and checks | Ensure code quality before committing changes | 🚧 To Do | [](https://github.com/) | + +--- + +### Others +| Feature | Description | Status | Developer (GitHub ID) | +|----------------------------------|--------------------------------------------------|-----------|------------------------------| +| Custom keyword search | Search for specific keywords within repositories| 🚧 To Do | [](https://github.com/developer8) | +| Filtering archived repositories | Exclude archived repositories from scanning | 🚧 To Do | [](https://github.com/developer8) | +| Filtering forked repositories | Exclude forked repositories from scanning | 🚧 To Do | [](https://github.com/developer8) | + +--- + + +**Legend:** +- ✅ Done: Completed feature. +- 🚧 To Do: Feature in progress. + +--- +## Additional Issues and Contributions +Contributors are welcome to explore and contribute to other issues on the xGitGuard repository: [xGitGuard GitHub Issues](https://github.com/Comcast/xGitGuard/issues) From 77c6a2391dfba29db33f978fd615357b819d0f74 Mon Sep 17 00:00:00 2001 From: "R.Adhithya" <33666474+radhi1991@users.noreply.github.com> Date: Mon, 8 Jul 2024 21:39:45 +0530 Subject: [PATCH 5/5] Update roadmap.md Changed the section under pre-commit hook by removing unnecessary items --- roadmap.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/roadmap.md b/roadmap.md index d3faa0e..a99ffa8 100644 --- a/roadmap.md +++ b/roadmap.md @@ -40,9 +40,8 @@ While a feature may not be listed here, it doesn't imply automatic refusal of a ### Pre-commit Hook | Feature | Description | Status | Developer (GitHub ID) | |----------------------------------|--------------------------------------------------|-----------|------------------------------| -| 🛠️ Multi-language package manager| Manage code checks and linters before commits | 🚧 To Do | [](https://github.com/) | -| 🛠️ Automatic installation of linters| Install necessary tools for code review | 🚧 To Do | [](https://github.com/) | -| 🛠️ Run code linters and checks | Ensure code quality before committing changes | 🚧 To Do | [](https://github.com/) | +| 🔒 Detecting secrets pre-commit| Detect secrets before committing changes | 🚧 To Do | [](https://github.com/) | + ---