Skip to content

docs: move contributor notes from CONTRIBUTING.md to README.md#26

Merged
stormer78 merged 5 commits intoOpenVTC:mainfrom
nidhi-9900:docs/expand-contributing-md
Apr 15, 2026
Merged

docs: move contributor notes from CONTRIBUTING.md to README.md#26
stormer78 merged 5 commits intoOpenVTC:mainfrom
nidhi-9900:docs/expand-contributing-md

Conversation

@nidhi-9900
Copy link
Copy Markdown
Contributor

@nidhi-9900 nidhi-9900 commented Apr 10, 2026

Closes #13

Moved the Getting Started, Workspace Layout, Building, Testing and PR Guidelines sections from CONTRIBUTING.md to README.md as requested in review.

Also resolved the merge conflict in CONTRIBUTING.md after upstream changes.

Signed-off-by: Nidhi Sharma <ns397048@gmail.com>
@nidhi-9900 nidhi-9900 requested a review from a team as a code owner April 10, 2026 20:14
Signed-off-by: Nidhi Sharma <ns397048@gmail.com>
Copy link
Copy Markdown
Contributor

@stormer78 stormer78 left a comment

Choose a reason for hiding this comment

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

This should reside in the README.md not the CONTRIBUTING.md file

@stormer78
Copy link
Copy Markdown
Contributor

@nidhi-9900 Can you respond to this? otherwise this will be automatically closed.

Signed-off-by: Nidhi Sharma <ns397048@gmail.com>
Signed-off-by: Nidhi Sharma <ns397048@gmail.com>
Signed-off-by: Nidhi Sharma <ns397048@gmail.com>
@nidhi-9900
Copy link
Copy Markdown
Contributor Author

Sorry for the late reply. Moved the notes to README.md and fixed the conflict.

@nidhi-9900 nidhi-9900 changed the title docs: expand CONTRIBUTING.md with workspace, build, and PR guidelines docs: move contributor notes from CONTRIBUTING.md to README.md Apr 14, 2026
Copy link
Copy Markdown
Contributor

@stormer78 stormer78 left a comment

Choose a reason for hiding this comment

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

LGTM

@stormer78 stormer78 merged commit 301ed2c into OpenVTC:main Apr 15, 2026
1 check passed
stormer78 added a commit that referenced this pull request Apr 15, 2026
Resolves conflicts from PRs #41 (SecretString hardening), #33 (typo fixes),
#26 (docs), and #43 (Windows docs) merging into main.

Conflict resolutions:
- cli.rs: kept openpgp-card cfg gate + anyhow::Result return type
- main.rs: adopted centralized process_lock, kept redact_paths helper
- state_handler/mod.rs: adopted channel-based TokenNotifier, kept LogFamily import
- setup_sequence/config.rs: combined expose_secret() with proper map_err handling
- settings_actions.rs: updated unlock_code to use SecretBox wrapper

Signed-off-by: Glenn Gore <glenn.g@affinidi.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expand CONTRIBUTING.md and cross-platform (Windows) setup guidance

2 participants