Skip to content

[DOCS]: Add Contributor Docs - #40

Merged
Nina Chikanov (nina-msft) merged 4 commits into
microsoft:mainfrom
nina-msft:dev/nina-msft/8981
May 18, 2026
Merged

[DOCS]: Add Contributor Docs#40
Nina Chikanov (nina-msft) merged 4 commits into
microsoft:mainfrom
nina-msft:dev/nina-msft/8981

Conversation

@nina-msft

@nina-msft Nina Chikanov (nina-msft) commented May 14, 2026

Copy link
Copy Markdown
Contributor

Co-authored-by: Copilot copilot@github.com

Description

Creates contribution documentation for the project. This includes dev setup, code style & linting info, testing standards, architecture specifics, how to extend RAMPART, PR process, and release process.

Other changes:

  1. This PR also removes the orphaned docs\guides folder, as these exist under docs\usage.
  2. Replaces pip install rampart with pip install git+https://github.com/microsoft/RAMPART.git

Breaking changes

None

Checklist

  • pre-commit run --all-files passes
  • Tests added or updated for changes --> N/A, doc-only
  • Documentation updated
  • uv run mkdocs serve --strict compiles (note to reviewer: run this command and view locally @ http://127.0.0.1:8000/)

Landing page:
image

Co-authored-by: Copilot <copilot@github.com>
@nina-msft
Nina Chikanov (nina-msft) requested a review from a team May 14, 2026 23:58
@nina-msft Nina Chikanov (nina-msft) changed the title [DOCS]: Add Contribution Documentation [DOCS]: Add Contributor Docs May 15, 2026
Comment thread docs/contributing/release-process.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks great, just a few nits :)

Comment thread docs/contributing/code-style.md Outdated
Comment thread docs/contributing/architecture.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, approved

Comment thread docs/contributing/release-process.md Outdated
Comment thread docs/contributing/extending-rampart.md Outdated
Comment thread docs/contributing/release-process.md Outdated
Comment thread docs/contributing/release-process.md
Comment thread docs/contributing/pull-requests.md
Comment thread docs/contributing/pull-requests.md Outdated
Comment thread docs/contributing/release-process.md Outdated
@nina-msft
Nina Chikanov (nina-msft) merged commit de08282 into microsoft:main May 18, 2026
11 checks passed
@nina-msft
Nina Chikanov (nina-msft) deleted the dev/nina-msft/8981 branch May 18, 2026 23:54
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.

3 participants