Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MISC] feat: add self assessment #3026

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

richzw
Copy link
Contributor

@richzw richzw commented Nov 9, 2023

Try to resolve #2977

Sorry that I have no idea about the part Secure development practices and Appendix of the self assessment, please give me more information.

@richzw richzw requested a review from hydai as a code owner November 9, 2023 08:12
Copy link
Member

juntao commented Nov 9, 2023

Hello, I am a code review bot on flows.network. Here are my reviews of code commits in this PR.


Commit 9c556a2cd7d688ab34f50631c61708594b43c294

The key changes in the pull request titled "[MISC] feat: add self assessment" by Wei Zang can be summarized as:

  1. A new file called 'self-assessment.md' is created under /docs directory. This file contains a comprehensive breakdown of the software details, use cases, security features, compliance information, security issue resolution process, and secure development practices.

  2. The SECURITY-INSIGHTS.yml file is modified to include a pointer to this newly added self-assessment document under the self-assessment section. This indicates that a self-assessment has been created for the project and specifies where the detailed self-assessment can be found.

Potential Issues:

  1. The pull request lacks tests and validation for the new feature.

  2. The self-assessment.md file includes several sections that are still incomplete. These include "Non-goals", "Compliance", "Development Pipeline", "Known Issues Over Time", "CII Best Practices", and "Related Projects / Vendors". These sections either lack details or have not been filled in at all. As such, it will be necessary to complete these sections before merging the pull request.

  3. The self-assessment.md file contains some absolute URLs pointing to Github. These URLs might break if file hierarchy or names change in the future.

  4. The document needs proof-reading to check for grammatical errors. For instance, in the "Ecosystem" section, "Flibber" and "Noodles" are mentioned, which appear unrelated to the project and possibly inserted erroneously.

Overall, the pull request is a great step towards self-documentation and transparency. However, it should be reviewed and completed before merging.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 9, 2023
Signed-off-by: Wei Zang <richzw@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Self-assessment
2 participants