From e4ff65b47259f6b219301adb27028c98dd89e279 Mon Sep 17 00:00:00 2001 From: Rahmadi Trimananda Date: Fri, 1 Nov 2024 14:50:56 -0400 Subject: [PATCH] Update README.md Moved "How to Contribute" to CONTRIBUTING.md. --- README.md | 32 +++++++++++++------------------- 1 file changed, 13 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index d34b6dc..8f6187e 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,47 @@ [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/Comcast/xCompass/badge)](https://securityscorecards.dev/viewer/?uri=github.com/Comcast/xCompass) -

xCOMPASS (COMcast Privacy ASSistant)

+# xCOMPASS (COMcast Privacy ASSistant)
xCOMPASS is a questionnaire developed from Models of Applied Privacy (MAP) personas. Privacy Threat Modeling (PTM) is part of software development lifecycle (SDL) along with the increasing awareness of data privacy. Unfortunately, PTM comes with the following limitations. First, it mostly involves human experts (i.e., threat modelers) with much manual effort. Second, it is usually performed later in the SDL pipeline, during which much development work has been finished. Third, the app developer is usually not familiar with privacy principles (e.g., privacy laws) that can guide the development process. To address these problems, xCOMPASS presents a lightweight questionnaire (i.e., yes-no questions), identifies privacy requirements based on the answers, and maps the requirements to privacy principles (e.g., privacy laws) and mitigation strategies (e.g., de-identification).
-

Learn More

+# Learn More + Please feel free to learn more about the questionnaire questions, as well as MAP framework by following these links: - [xCOMPASS Questionnaire](https://github.com/Comcast/xCOMPASS/tree/main/questionnaire) - [Models of Applied Privacy (MAP) personas](https://github.com/Comcast/xCOMPASS/tree/main/personas) -

How to Contribute?

-We welcome all kinds of contributions to this framework, especially: - -- Changes to xCOMPASS questions, language, typos, fixes, etc. -- Deeper dive into privacy design strategies. -- Linking to other principles beyond FIPPS. -- Additional personas beyond those already in [xCOMPASS.md](/xCOMPASS/personas.md), using the different combinations from the framework above. -- Specific use cases of MAP (please create a new folder for each use case) in your industry, even if hypothetical. -- Changes to language, typos, fixes, etc. +# Contribution -However, if you have other ideas, albeit simple, please do not hesitate to connect with us. For contribution to xCOMPASS questionnaire, please find more information [here](https://github.com/Comcast/xCompass/edit/main/xCOMPASS/README.md#-how-to-contribute-). Please also have a look at more instructions to commit your contribution in [CONTRIBUTING.md](https://github.com/Comcast/xCompass/blob/main/CONTRIBUTING.md). +We welcome all kinds of contributions to this repository! Please have a look at [CONTRIBUTING.md](https://github.com/Comcast/xCompass/blob/main/CONTRIBUTING.md) for further information and guidelines. -

Maintainers

+# Maintainers -The list of maintainers of this GitHub repository is available in [MAINTAINERS.md](https://github.com/Comcast/xCOMPASS/blob/main/MAINTAINERS.md). +The list of maintainers of this GitHub repository is available in [MAINTAINERS.md](https://github.com/Comcast/xCOMPASS/blob/main/MAINTAINERS.md). Please consider becoming a maintainer! :smiley: -

Roadmap

+# Roadmap Roadmap information is available in [ROADMAP.md](https://github.com/Comcast/xCOMPASS/blob/main/ROADMAP.md). -

List of Publications

+# List of Publications Jayati Dev, Bahman Rashidi, Vaibhav Garg. [Models of Applied Privacy (MAP): A Persona Based Approach to Threat Modeling.](https://dl.acm.org/doi/fullHtml/10.1145/3544548.3581484) In Proceedings of the 2023 CHI Conference on Human Factors in Computing Systems (CHI '23). -

List of Talks

+# List of Talks - Rahmadi Trimananda. [The Golden xCOMPASS: The Compass You Need to Navigate through the App-Privacy Universe!](https://www.usenix.org/conference/soups2024/technical-sessions) USENIX SOUPS 2024 Lightning Talks. - Rahmadi Trimananda. [The Golden xCOMPASS: The Compass You Need to Navigate through the App-Privacy Universe!](https://digitalprivacy.ieee.org/events/digital-privacy-workshop) IEEE Digital Privacy Workshop 2024. - Rahmadi Trimananda. [The Golden xCOMPASS: The Compass You Need to Navigate through the App-Privacy Universe!](https://lascon.org/speakers/) OWASP LASCON 2024. -

Visibility on Other Websites

+# Visibility on Other Websites + xCOMPASS has been proudly listed as an open-sourced privacy engineering requirements identification tool on various websites including: - [NIST Privacy Risk Assessment Tools](https://www.nist.gov/itl/applied-cybersecurity/privacy-engineering/collaboration-space/privacy-risk-assessment/tools) - [CISA Free Cybersecurity Services and Tools](https://www.cisa.gov/resources-tools/services/xcompass) - [OWASP Free for Open Source Application Security Tools](https://owasp.org/www-community/Free_for_Open_Source_Application_Security_Tools) -

License

+# License Licensed under [Apache 2.0](https://github.com/Comcast/MAP/blob/main/LICENSE-Apache-2.0).