Update documentation for binding generation

オープン
#63 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
rust
領域
documentation

調査の方向性

まず、rust-symcrypt と symcrypt-sys の既存の開発者向けドキュメントと binding 生成ワークフローを見つけます。SymCrypt と buildinfo.h の変更、binding またはアルゴリズムの更新、cargo publish --dry-run、clippy、cargo fmt、release-draft の更新、binding チェック、binding 生成を含むバージョン更新を文書化します。完了とは、一覧にある各手順を再現できることを意味します。

索引モデルが issue の本文から書いたものです。

説明

Write rust-symcrypt developer docs.

Should include:

  • Procedure for updating rust-symcrypt and symcrypt-sys version ex: cargo publish --dry-run
  • Procedure for updating underlying SymCrypt version. This would be for both the static linking, as well as bindings (buildinfo.h)
  • Procedure for updating the bindings / adding a new algorithm to rust-symcrypt
  • Dev checks that must be preformed before checking in a branch, ex: (clippy, cargo fmt, updating the release draft, checking bindings)
  • How to generate new bindings
主要言語
Rust
スター
73
フォーク
16
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

microsoft/rust-symcrypt のほかの issue

microsoft/rust-symcrypt の issue をすべて見る

似ている issue

Rust の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。