Skip to content

Commit

Permalink
Merge pull request #848 from davidsemakula/master
Browse files Browse the repository at this point in the history 
ink! analyzer milestone 1 (#1615)
  • Loading branch information
@dsm-w3f
dsm-w3f authored May 9, 2023
2 parents 4c677b2 + 1fe0d57 commit 362696c
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions deliveries/ink-analyzer-milestone-1.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Milestone Delivery :mailbox:

**The [invoice form :pencil:](https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp-hd8mhIiO0A/viewform) has been filled out correctly for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/milestone-deliverables-guidelines.md).**

* **Application Document:** [ink! Analyzer](https://github.com/w3f/Grants-Program/blob/master/applications/ink-analyzer.md)
* **Milestone Number:** 1

**Context** (optional)

Please see the [README](https://github.com/ink-analyzer/ink-analyzer#readme) for additional context about the deliverables.

**Deliverables**

| Number | Deliverable | Link | Notes |
|---------|----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **0a.** | License | [MIT](https://github.com/ink-analyzer/ink-analyzer/blob/master/LICENSE-MIT) or [Apache 2.0](https://github.com/ink-analyzer/ink-analyzer/blob/master/LICENSE-APACHE). | Dual-licensed under either of MIT or Apache 2.0 licenses at the downstream user's option. |
| **0b.** | Documentation | [README](https://github.com/ink-analyzer/ink-analyzer#readme) on GitHub, rustdoc documentation on docs.rs for [semantic analyzer crate (ink-analyzer)](https://docs.rs/ink-analyzer/latest/ink_analyzer/), [IR crate (ink-analyzer-ir)](https://docs.rs/ink-analyzer-ir/latest/ink_analyzer_ir/), [proc-macro crate (ink-analyzer-macro)](https://docs.rs/ink-analyzer-macro/latest/ink_analyzer_macro/) and extensive inline source documentation in all 3 crates. | Each crate directory additionally includes a crate specific README (published on both GitHub - [here](https://github.com/ink-analyzer/ink-analyzer/tree/master/crates/analyzer), [here](https://github.com/ink-analyzer/ink-analyzer/tree/master/crates/ir) and [here](https://github.com/ink-analyzer/ink-analyzer/tree/master/crates/macro) - and crates.io - [here](https://crates.io/crates/ink-analyzer), [here](https://crates.io/crates/ink-analyzer-ir) and [here](https://crates.io/crates/ink-analyzer-macro)) that's targeted at library users and contains crate specific instructions for installation and usage and links to crate specific documentation on docs.rs. |
| **0c.** | Testing and Testing Guide | [Testing guide](https://github.com/ink-analyzer/ink-analyzer#testing). | See the diagnostics module doc for [methodology for extracting ink! semantic rules](https://github.com/ink-analyzer/ink-analyzer/blob/master/crates/analyzer/src/analysis/diagnostics.rs#L1-L18). References to the source of enforced semantic rules in the [ink_ir crate](https://github.com/paritytech/ink/blob/v4.1.0/crates/ink/ir/src/lib.rs) are included either in the rustdoc for most utilities or at the call site for more generic utilities. |
| **0d.** | Docker | [Dockerfile](https://github.com/ink-analyzer/ink-analyzer/blob/master/Dockerfile). | |
| 1. | Semantic Analyzer: Rust library crate: Diagnostic errors | [GitHub repository](https://github.com/ink-analyzer/ink-analyzer), [Semantic analyzer crate (ink-analyzer)](https://crates.io/crates/ink-analyzer), [IR crate (ink-analyzer-ir)](https://crates.io/crates/ink-analyzer-ir) and [proc-macro crate (ink-analyzer-macro)](https://crates.io/crates/ink-analyzer-macro). | See the [architecture section of the README](https://github.com/ink-analyzer/ink-analyzer#architecture) to understand the purpose of each crate and the relationship between the crates. |

**Additional Information**

Please use the [master branch](https://github.com/ink-analyzer/ink-analyzer/tree/master) for testing, another branch will be used for continued work until the completion of the review.

0 comments on commit 362696c

Please sign in to comment.