mirror of
https://github.com/xazukx/ts-rs.git
synced 2026-11-15 22:00:26 +00:00
Change CONTRIBUTING.md to avoid UTF-16 encoding issue (#201)
This commit is contained in:
+9
-3
@@ -3,8 +3,14 @@ If you are unsure what to work on or want to discuss your idea, feel free to ope
|
||||
|
||||
### Documentation
|
||||
After implementing a new feature, please document it in the doc comment on `TS` in `ts_rs/lib.rs`.
|
||||
`README.md` is generated from the module doc comment in `ts_rs/lib.rs`. If you added/updated documentation there, run
|
||||
`cargo readme > ../README.md` from the `ts-rs/` directory.
|
||||
`README.md` is generated from the module doc comment in `ts_rs/lib.rs`. If you added/updated documentation there, go to the `ts-rs/` directory and run one of the following commands:
|
||||
|
||||
On Windows:
|
||||
`cargo readme -o ..\README.md`
|
||||
|
||||
On other systems:
|
||||
`cargo readme > ../README.md`
|
||||
|
||||
You can install `cargo readme` by running `cargo install cargo-readme`.
|
||||
|
||||
|
||||
@@ -16,4 +22,4 @@ There is nothing special going on here - just run `cargo build`.
|
||||
To run the test suite, just run `cargo test` in the root directory.
|
||||
|
||||
### Formatting
|
||||
To ensure proper formatting, please run `cargo +nightly fmt`.
|
||||
To ensure proper formatting, please run `cargo +nightly fmt`.
|
||||
|
||||
Reference in New Issue
Block a user