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

Create alphaday.md #2394

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Create alphaday.md #2394

wants to merge 3 commits into from

Conversation

Mikael337
Copy link

Project Abstract

Please replace these instructions with a brief description of your project summarising key points (1-2 paragraphs).

If your application is a follow-up to a previous grant, please mention which one in the first line of the abstract and include a link to previous pull requests if applicable.

Grant level

  • Level 1: Up to $10,000, 2 approvals
  • Level 2: Up to $30,000, 3 approvals
  • Level 3: Unlimited, 5 approvals (for >$100k: Web3 Foundation Council approval)

Application Checklist

  • The application template has been copied and aptly renamed (project_name.md).
  • I have read the application guidelines.
  • Payment details have been provided (Polkadot AssetHub (DOT, USDC & USDT) address in the application and bank details via email, if applicable).
  • I understand that an agreed upon percentage of each milestone will be paid in vested DOT, to the Polkadot address listed in the application.
  • I am aware that, in order to receive a grant, I (and the entity I represent) have to successfully complete a KYC/KYB check.
  • The software delivered for this grant will be released under an open-source license specified in the application.
  • The initial PR contains only one commit (squash and force-push if needed).
  • The grant will only be announced once the first milestone has been accepted (see the announcement guidelines).
  • I prefer the discussion of this application to take place in a private Element/Matrix channel. My username is: @_______:matrix.org (change the homeserver if you use a different one)

@github-actions github-actions bot added the admin-review This application requires a review from an admin. label Sep 13, 2024
@Mikael337
Copy link
Author

Mikael337 commented Sep 13, 2024

Hello @keeganquigley, I have reopened this pull request since we have now fully open sourced Alphaday here: https://github.com/AlphadayHQ/alphaday
License: MIT

I request that you please reconsider the application.
Previous Application for reference: #2285

Copy link
Contributor

@keeganquigley keeganquigley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Mikael337 happy to reconsider. I have a few initial comments:

  • The grants program focuses mainly on the technical implementation, so while we can fund the development itself, we can't fund things like Youtube stream containing educational Polkadot/Kusama/Web3 content or the podcast. Could you please remove these from the deliverables?
  • The mandatory deliverables 0a. - 0d. are missing. Can you please add these as shown in the application template?

@keeganquigley keeganquigley added the changes requested The team needs to clarify a few things first. label Sep 13, 2024
@Mikael337
Copy link
Author

Hello @keeganquigley, I've updated the file with the newly requested changes.
Please let me know if other changes are required.

| Number | Deliverable | Specification |
| -----: | ----------- | ------------- |
| 0a. | License | MIT |
| 0b. | Documentation | Not applicable to Alphaday, as we have no Substrates nodes or sending functionality on the app |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation is always required for development milestones, regardless of the tech stack. At the very least a GH readme, but it's nice to see user-facing documentation as well, for front-end deliverables.

| -----: | ----------- | ------------- |
| 0a. | License | MIT |
| 0b. | Documentation | Not applicable to Alphaday, as we have no Substrates nodes or sending functionality on the app |
| 0c. | Testing Guide | We can provide a document as a guide to give a bit more detail on how to test a completed dashboard's functionality. It will be a reference to the points listed below (1-14) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We require unit tests as well, at least for the Python-Django backend. (But it's also nice to see Cypress tests or something similar for React front-ends). Would you be willing to include these?

applications/alphaday.md Outdated Show resolved Hide resolved
applications/alphaday.md Outdated Show resolved Hide resolved
Copy link
Contributor

@keeganquigley keeganquigley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In addition to my above comments, we also require mockups for the front-end if you could include those too. Thanks!

@Mikael337
Copy link
Author

Hello @keeganquigley ,

Thank you for the feedback.

I spoke to the devs in our team and we are not able to provide:

  • Mockups for the front-end
  • Unit tests
  • Documentation for front-end deliverables

The reasons varied.

I have gone ahead and removed the Docker file from the milestones and changed the duration of Milestone 2 to 2 months, as per your request.

Please let me know if we can still proceed without providing the 3 listed points above, or if there is a workaround somehow.

@keeganquigley
Copy link
Contributor

Thanks for your response @Mikael337, and for talking with your team.

I know this grant is rather small, so it makes sense to be small in scope. Therefore I understand it might not have certain components. Unfortunately, the above-mentioned deliverables are mandatory, so it would be unfair to other projects if we were to accept this one without them.

The lack of mockups is the one item that could probably be forgiven at the current price. However, the lack of unit tests perplexes me because all code should generally be tested, with perhaps one exception for code written at a hackathon. Documentation is also something we have to have, otherwise how would we know how to run and test it?

Therefore, I personally won't approve the application; however, I will mark it as ready for review in case other committee members disagree.

@keeganquigley keeganquigley added ready for review The project is ready to be reviewed by the committee members. and removed changes requested The team needs to clarify a few things first. labels Sep 25, 2024
Copy link
Member

@semuelle semuelle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you unable to provide unit tests? Any decent open source project should have thorough testing where applicable. If not, I don't think we should support it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
admin-review This application requires a review from an admin. ready for review The project is ready to be reviewed by the committee members.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants