From 626c2a0b5990de797e4f0af69f635dcf744bb580 Mon Sep 17 00:00:00 2001 From: Rohan Kaushik Date: Fri, 10 Mar 2023 15:55:15 +0530 Subject: [PATCH 01/14] Updated README.md --- README.md | 95 +++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 89 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c86ad7e785..278f53eea4 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,91 @@ -https://www.github.com/OWASP/BLT -https://www.github.com/OWASP/BLT-Flutter -https://www.github.com/OWASP/BLT-Extension -https://www.github.com/OWASP/BLT-Bacon -https://www.github.com/OWASP/BLT-Action +# OWASP BLT -https://owasp.org/www-project-bug-logging-tool/ + + +[![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions) + +--- + +**Report issues and get points, companies are held accountable.** + +- OWASP BLT is a bug logging tool to report issues and get points, companies are held accountable. + +- Users will get rewards/points for reporting bugs on Organizations / Companies. + +- Organizations / Companies can launch their bug hunt programs with prize pools. + +- Read more about [BLT](https://owasp.org/www-project-bug-logging-tool/) + + +# Development + +### Setting Up Development Server + + + +Please follow the development server setup procedure [here](https://github.com/OWASP/BLT/blob/main/Setup.md). Currently, development server can be installed using docker or vagrant. You can also use virtualenv or pipenv install, pipenv shell and then continue with the remaining instructions. + + + +### Documentation + + + +- use the [Installation Docs ](https://github.com/OWASP/BLT/blob/main/Setup.md) to get started. + +- Swagger API Documentations can be found at the root domain /swagger/ + +- Postman API Documentations: [Postman Docs](https://documenter.getpostman.com/view/19782933/VUqpscyV). + + + +### Resources + + + +- Join the [OWASP Slack Channel](https://owasp.org/slack/invite) and ask questions at **#project-blt** + +- Github activity can be seen in Slack **#blt-github**. + +- Figma designs for web and flutter app are available [here](https://www.figma.com/file/s0xuxeU6O2guoWEfA9OElZ/Design) + + + +### Other BLT Projects + +- [OWASP/BLT](https://www.github.com/OWASP/BLT) + +- [OWASP/BLT-Flutter](https://www.github.com/OWASP/BLT-Flutter) + +- [OWASP/BLT-Extension](https://www.github.com/OWASP/BLT-Extension) + +- [OWASP/BLT-Bacon](https://www.github.com/OWASP/BLT-Bacon) + +- [OWASP/BLT-Action](https://www.github.com/OWASP/BLT-Action) + + + +### Coding style guide + + + +Please follow the [black](https://github.com/psf/black) code style for the project. It helps us in keeping the codebase consistent and improves readability for other developers. + + + +### License + +The BLT code is released under [GNU Affero General Public License v3.0 (AGPL-3.0)](https://github.com/OWASP/BLT/blob/master/LICENSE). + + + +## Notes + + + +- If you find a bug or have an improvement, use BLT to report it! + +- for each new issue, create a new branch with issue-382 or similar matching the issue number - when you commit add fixes #288 to link the issue to the pull request + +- to take a github issue type a comment that says "assign to me" or /assign and it will assign it to you. \ No newline at end of file From 25ea18c5c832db984a5f44be52615f81a11d972a Mon Sep 17 00:00:00 2001 From: Rohan Kaushik Date: Fri, 10 Mar 2023 23:48:06 +0530 Subject: [PATCH 02/14] Updated README.md #1 --- README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 70 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 278f53eea4..3c51aa4155 100644 --- a/README.md +++ b/README.md @@ -1,91 +1,156 @@ -# OWASP BLT +

OWASP BLT

+

- + + +GitHub stars [![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions) +

+ --- -**Report issues and get points, companies are held accountable.** + + +**Report issues and get points, companies are held accountable.** -- OWASP BLT is a bug logging tool to report issues and get points, companies are held accountable. + + +- OWASP BLT is a bug logging tool to report issues and get points, companies are held accountable. + + - Users will get rewards/points for reporting bugs on Organizations / Companies. + + - Organizations / Companies can launch their bug hunt programs with prize pools. -- Read more about [BLT](https://owasp.org/www-project-bug-logging-tool/) + + +- Read more about [BLT](https://owasp.org/www-project-bug-logging-tool/) + + # Development + + ### Setting Up Development Server + + Please follow the development server setup procedure [here](https://github.com/OWASP/BLT/blob/main/Setup.md). Currently, development server can be installed using docker or vagrant. You can also use virtualenv or pipenv install, pipenv shell and then continue with the remaining instructions. + + ### Documentation + + - use the [Installation Docs ](https://github.com/OWASP/BLT/blob/main/Setup.md) to get started. + + - Swagger API Documentations can be found at the root domain /swagger/ + + - Postman API Documentations: [Postman Docs](https://documenter.getpostman.com/view/19782933/VUqpscyV). + + ### Resources + + - Join the [OWASP Slack Channel](https://owasp.org/slack/invite) and ask questions at **#project-blt** + + - Github activity can be seen in Slack **#blt-github**. + + - Figma designs for web and flutter app are available [here](https://www.figma.com/file/s0xuxeU6O2guoWEfA9OElZ/Design) + + ### Other BLT Projects + + - [OWASP/BLT](https://www.github.com/OWASP/BLT) + + - [OWASP/BLT-Flutter](https://www.github.com/OWASP/BLT-Flutter) + + - [OWASP/BLT-Extension](https://www.github.com/OWASP/BLT-Extension) + + - [OWASP/BLT-Bacon](https://www.github.com/OWASP/BLT-Bacon) + + - [OWASP/BLT-Action](https://www.github.com/OWASP/BLT-Action) + + ### Coding style guide + + Please follow the [black](https://github.com/psf/black) code style for the project. It helps us in keeping the codebase consistent and improves readability for other developers. + + ### License + + The BLT code is released under [GNU Affero General Public License v3.0 (AGPL-3.0)](https://github.com/OWASP/BLT/blob/master/LICENSE). + + ## Notes + + - If you find a bug or have an improvement, use BLT to report it! + + - for each new issue, create a new branch with issue-382 or similar matching the issue number - when you commit add fixes #288 to link the issue to the pull request + + - to take a github issue type a comment that says "assign to me" or /assign and it will assign it to you. \ No newline at end of file From cad83c40fb4cdcbeb55fc3ff7eddd689c47465c9 Mon Sep 17 00:00:00 2001 From: Rohan Kaushik Date: Fri, 10 Mar 2023 23:48:52 +0530 Subject: [PATCH 03/14] Updated README.md #2 --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index 3c51aa4155..c25cd65d3a 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,7 @@

- - -GitHub stars - -[![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions) +GitHub stars[![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions)

From 51e048d95811675bc40a4be9a65ad809a8efee49 Mon Sep 17 00:00:00 2001 From: Rohan Kaushik Date: Fri, 10 Mar 2023 23:49:18 +0530 Subject: [PATCH 04/14] Updated README.md #3 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c25cd65d3a..7965445baf 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@

-GitHub stars[![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions) + GitHub stars [![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions)

From 6b8d7f5a9290bd7d406ef554213fb506793a7184 Mon Sep 17 00:00:00 2001 From: Rohan Kaushik Date: Fri, 10 Mar 2023 23:49:46 +0530 Subject: [PATCH 05/14] Updated README.md #4 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7965445baf..79dbb66fd8 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@

- GitHub stars [![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions) + GitHub stars [![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions)

From 9e7402a18980a488ce4c175cbc334c0a58c8174a Mon Sep 17 00:00:00 2001 From: Rohan Kaushik Date: Fri, 10 Mar 2023 23:50:17 +0530 Subject: [PATCH 06/14] Updated README.md #5 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 79dbb66fd8..2699f4f68c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@

- GitHub stars [![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions) + GitHub stars [![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions)

From 7aaa8532e29823228748a69fb51e10f0be57105e Mon Sep 17 00:00:00 2001 From: Rohan Kaushik Date: Fri, 10 Mar 2023 23:51:38 +0530 Subject: [PATCH 07/14] Updated README.md #6 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2699f4f68c..b6d7cd7827 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@

- GitHub stars [![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions) +  GitHub stars  [![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions)

From fdf9ed09d8581738700776ce6adbd8968fd36a6d Mon Sep 17 00:00:00 2001 From: Rohan Kaushik Date: Fri, 10 Mar 2023 23:54:34 +0530 Subject: [PATCH 08/14] Updated README.md #7 --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b6d7cd7827..71e5f197c2 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ -

OWASP BLT

+

OWASP BLT

-  GitHub stars  [![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions) + +GitHub stars +[![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions)

From 88fd1456d77c9e37dd37d3b7b56d5f2d39d8d317 Mon Sep 17 00:00:00 2001 From: Rohan Kaushik Date: Fri, 10 Mar 2023 23:55:35 +0530 Subject: [PATCH 09/14] Updated README.md #8 --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 71e5f197c2..96ddd5c273 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,8 @@

OWASP BLT

-

- - +

GitHub stars -[![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions) - -

+[![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions)

--- From 128d41824e48d23bef3f9c6b9c371d4cb18b2cab Mon Sep 17 00:00:00 2001 From: Rohan Kaushik Date: Fri, 10 Mar 2023 23:56:27 +0530 Subject: [PATCH 10/14] Updated README.md #9 --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 96ddd5c273..43b258bc74 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@

GitHub stars + [![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions)

--- From 312e4a7bb35a553a74e0482585e658b6b2af24b1 Mon Sep 17 00:00:00 2001 From: Rohan Kaushik Date: Fri, 10 Mar 2023 23:58:20 +0530 Subject: [PATCH 11/14] Updated README.md #10 --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 43b258bc74..3b089983d2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,9 @@

OWASP BLT

-

-GitHub stars +

-[![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions)

- +[![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions) +GitHub stars

--- From fd20cd3b438b458e88638c252eb4f3929a6f95da Mon Sep 17 00:00:00 2001 From: Rohan Kaushik Date: Sat, 11 Mar 2023 00:00:27 +0530 Subject: [PATCH 12/14] Updated README.md #11 --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 3b089983d2..20d20566b8 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@

OWASP BLT

-

-[![Build Status](https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg)](https://github.com/OWASP/BLT/actions) +

Build GitHub stars

--- From 9213ef8b5a1d2eacfd1aac139337ad1f9b294ed1 Mon Sep 17 00:00:00 2001 From: Rohan Kaushik Date: Sat, 11 Mar 2023 00:01:30 +0530 Subject: [PATCH 13/14] Updated README.md #12 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 20d20566b8..1f99229055 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@

OWASP BLT

-

Build +

Build GitHub stars

---- +------ From c9f9d73c16329fd44fe4a086864452c3b5a0afe1 Mon Sep 17 00:00:00 2001 From: Rohan Kaushik Date: Sat, 11 Mar 2023 00:02:01 +0530 Subject: [PATCH 14/14] Updated README.md #12 --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 1f99229055..92fd8ebd99 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@

Build GitHub stars

+ ------