Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update milestone-delivery template #3

Merged
merged 10 commits into from
Sep 9, 2024
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,26 @@

Prior to submitting your first milestone, please make sure that you have successfully completed a [KYB](https://in.sumsub.com/idensic/l/#/uni_LhZH9SdrmtuvGnnz) (or, if you work alone, a [KYC](https://in.sumsub.com/idensic/l/#/uni_ZUSbgdezo6hdrZVn)) check.
anaelleltd marked this conversation as resolved.
Show resolved Hide resolved

1. **Milestone Delivery:**
### Milestone Delivery:
1. Make sure that your delivery adheres to the [JAM Prize rules](https://jam.web3.foundation/rules).
2. [Fork this repository](https://github.com/w3f/jam-milestone-delivery/fork).
3. If this is your first milestone, create a folder for your team/project under the `deliveries` folder.
4. Create a copy of the milestone delivery template ([`deliveries/milestone-delivery-template.md`](deliveries/milestone-delivery-template.md)) in your folder. Make sure you **do not modify the template file directly**.
5. Fill out the template with the details of your milestone, including all deliverables as listed in your application.
6. Name the file `project_name-milestone_number.md`.
7. Create a pull request and fill out the comment template.
2. **Milestone Review:**

### Milestone Review:
1. [Polkadot Fellows](https://polkadot-fellows.github.io/dashboard/) can (and usually do) issue questions, comments and may request changes on the pull request. Their feedback needs to be resolved before your milestone is accepted.
2. An admin will merge your pull request to accept the delivery.
3. **Milestone Payment:**

### Milestone Payment:
1. After the milestone is approved and the pull request merged, fill out the [invoice form](TODO).
2. Payment is made to the Polkadot address specified in the invoice.


## Requirements

Please check the [JAM Prize website](https://jam.web3.foundation/) for participation rules.
Please check the [JAM Prize website](https://jam.web3.foundation/) for participation rules.

## Additional information

Expand Down
75 changes: 74 additions & 1 deletion deliveries/milestone-delivery-template.md
Original file line number Diff line number Diff line change
@@ -1 +1,74 @@
# Milestone Delivery
# JAM Milestone Delivery

> Don't remove any of the mandatory parts presented in bold letters or as headlines! Lines starting with >, such as this one, can be removed.


## Company/Team details

>Please provide all the required information below.

- Company/Team's name:
- Company/Team's GitHub:
- Programming language and language set:
- Link/s to previous delivery/ies:


## Documentation checklist

>Please check the boxes to confirm that you have provided all the required documentation, providing direct links whenever possible. **DO NOT** include links to confidential or private documents.

>Chose the relevant option(s) (e.g. Option A | Option B | etc.) and delete the rest.

We declare that:

- [ ] we have completed **the Web3 Foundation KYC/KYB process**.
anaelleltd marked this conversation as resolved.
Show resolved Hide resolved
- [ ] we used **a clear and permissive open-source license**.
- [ ] we submitted **a clear Git history and public, credibly timestamped commits** | **code developed in private, with commit hashes placed, in a timely fashion, on a major public blockchain**.
- [ ] we used third party libraries for: **cryptographic primitives** (e.g. erasure-coding, Bandersnatch, Ed25519) | **codecs** (e.g. SCALE) | **networking** (e.g. QUIC).
- [ ] we provided **Gas, trie/DB, signature-verification, and availability (EC/DB) performance tests** to be run on standard hardware.
- [ ] we viewed the following **JAM implementation code** before | during our implementation.
- [ ] we have not | have had private conversations with **other | the following implementers**.
- [ ] we have not | have had **concerns about collusion**.
- [ ] we agree to a recorded interview by the *Polkadot Technical Fellowship* on any matter arising from this milestone submission.
- [ ] we understand that this milestone submission will need to be ratified with an on-chain remark by the *Polkadot Technical Fellowship* before it can be merged.



## Context

>Please present your rationale for the completion of this milestone by connecting the deliverables and describing their purpose.


## Deliverables

>Please check the relevant box to indicate which milestone you are delivering.

- [ ] 1. IMPORTER: State-transitioning conformance tests pass and can import blocks.
- [ ] 2. AUTHOR: Fully conformant and can produce blocks (including networking, off-chain).
- [ ] 3. HALF-SPEED: Conformance and Kusama-level performance (including PVM implementation).
- [ ] 4. FULL-SPEED: Conformance and Polkadot-level performance (including PVM implementation).
- [ ] 5. SECURE: Fully audited.


>Please provide a list of all deliverables for the milestone and include links to the actual deliverables.

>Ideally all links inside the table below should include a commit hash, which will be used for testing. If you don't provide a commit hash, we will work off the default branch of your repository. Thus, if you plan on continuing work after delivery, we suggest you create a separate branch for either the delivery or your continuing work.

>If there is anything particular about any of the deliverables we or a future reader should know, use the respective Notes column.

| Number | Deliverable | Link | Notes |
|---------|-------------|--------|-------|
|1. |... | ... |... |
|2. |... | ... |... |
|3. |... | ... |... |
|4. |... | ... |... |
|5. |... | ... |... |


## Additional Information

>Provide any relevant comments on the milestone submission that you would like to share with us.




Loading