BlockchainCommons / BlockchainCommons/Community

Project: Document Best Practices for Secure Software Open Development

Open
#129 1 comment 0 reactions 0 assignees View on GitHub
good first issue intern project
Dominant language
No language data
Stars
68
Forks
7
PR merge metrics
No merged PRs in 30d

Description

This is another project that would be good for a team with mixed skills, and does not require deeper software engineering experience (but at least one should have experience with build processes).

Various organizations (Linux Foundation, Google, etc.) have offered guidance as to the practices of security, supply chain, etc. , but also emphasize enterprise and OS supply chain use cases. There are also a number of automated tools (apps, GitHub actions, etc.) that can be used to audit on some of these.

However, many are not practical for smaller projects, especially the emerging blockchain security repos, where only a few people may be contributing.

The goal of this project is to survey the existing recommended practices, best practices of various important security projects (including Blockchain Commons practices), etc., to identify which address the biggest threats given the effort (threat analysis), are practical for small projects to implement, which we might be able to offer some documentation and examples of how best to install and use, and guidance to contributors to small projects on how to tool and support this practices (like docs teaching git signing for writers contributing documentation to a secure repo).

Related to: reproducible builds, scripts for protecting master branch, etc.. What are our best practices and what do we recommend to other parties (especially for our CLI apps) @nochiel

Contributor guide

Open the contributing guide

Research direction

No files or tests are named. Start by surveying the Linux Foundation and Google guidance, security-project practices, Blockchain Commons practices, reproducible builds, branch-protection scripts, and Git signing. Done means documenting a threat-and-effort analysis, practical recommendations for small projects, and relevant tooling or usage examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github-actions
Domain
cli, devops, documentation, security
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.