Skip to content

Conversation

@secsovereign
Copy link
Contributor

Description

Update development documentation to align with BitVault's architecture and establish consistent contribution guidelines

Changes

Setup Documentation

  • Update Arch Linux setup guide to include BitVault-specific dependencies
  • Add security-specific tools and testing requirements
  • Update Makefile to remove Tauri and add security-focused targets

Contribution Guidelines

  • Add standardized CONTRIBUTING.md in root directory
  • Create detailed contribution guidelines with security focus
  • Establish commit message conventions with imperative style
  • Add professional CODE_OF_CONDUCT.md
  • Implement branch naming conventions and PR templates

Security Considerations

These documentation updates emphasize security-first development practices and provide clear guidance on handling security-critical code, including:

  • Process isolation and security boundary awareness
  • Proper handling of sensitive information
  • Security disclosure process
  • Review requirements for security-critical changes

Testing

Documentation has been reviewed for:

  • Consistency with project architecture
  • Accuracy of setup instructions
  • Clarity of contribution process
  • Alignment with security principles

Add standardized project documentation:
- Create root CONTRIBUTING.md with quick reference
- Add detailed contribution guidelines with security focus
- Create commit convention standards for consistency
- Add professional CODE_OF_CONDUCT.md

Ensures consistent development workflow and clarifies
contribution process for new developers.
- Update README.md to fix license reference (Apache 2.0 not MIT)
- Remove incorrect technology assumptions across all documents
- Standardize project structure descriptions
- Ensure consistent security information
- Improve cross-references between documentation files
@secsovereign secsovereign added the documentation Improvements or additions to documentation label Mar 11, 2025
@secsovereign secsovereign self-assigned this Mar 11, 2025
@secsovereign
Copy link
Contributor Author

@jnowakowski @ilghan
Would you mind reviewing these changes to ensure they accurately represent our project's vision, security approach, and contribution process? Feedback welcome.

@secsovereign secsovereign requested review from ilghan and jnowakowski and removed request for ilghan and jnowakowski March 11, 2025 02:15
Copy link
Contributor

@jnowakowski jnowakowski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, with a small nitpick: please rename makefile to Makefile to avoid potential confusion.

@secsovereign secsovereign merged commit 364ce15 into main Mar 18, 2025
1 check failed
@cryptoquick cryptoquick deleted the docs/update-setup-guides branch March 22, 2025 19:49
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.

3 participants