tsarevvv/rust-ipfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update pull-request-template.md

Browse Source
This commit is contained in:
Mark Robert Henderson 2020-03-12 14:13:12 -04:00 committed by GitHub
parent ac46443527
commit d35ff20df2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
.github/PULL_REQUEST_TEMPLATE/pull-request-template.md vendored
View File

@ -0,0 +1,17 @@
<!-- Fill in the blank: -->
This PR ______, so that ____.
Additionally, updates should conform closely as possible to the [Definition of Done](https://github.com/ipfs/devgrants/tree/master/open-grants/ipfs-rust#definition-of-done) defined in the devgrant proposal. This includes:
- [ ] There is a working Rust implementation of the command’s functionality
- [ ] Code is “linted” i.e. code formatting via rustfmt and language idioms via clippy
- [ ] There is an HTTP binding for said command exposed via the IPFS daemon
- [ ] (Optional) There is a CLI command that utilizes either the Rust APIs or the HTTP APIs
- [ ] There are functional and/or unit tests written, and they are passing
- [ ] There is suitable documentation. In our case, this means:
- [ ] Each command has a usage example and API specification
- [ ] Top-level commands with subcommands display usage instructions
- [ ] Rustdoc tests are passing on all code-level comments
- [ ] Differences between Rust’s implementation and Go or JS are explained
- [ ] There are passing conformance tests, approved by Protocol Labs