Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 2.4 KB

Contributing

First of all, thank you for considering to contribute. Please look at the details below:

To learn more about how to contribute to a project through forking, follow these steps.

If it's your first time contributing, check out this tutorial.

New Resources

For new resources, submit a resource by submitting a pull request with your suggested resource. Ensure to match the format of the other resources.

Existing Resources

For the existing resources, you may:

  • Fix Typos / Broken Links: Make your changes and submit a PR. You may also raise in the discussions. Include your reasoning for why the addition is valuable.
  • Remove (Outdated) Resources: Share your suggestion in a PR or raise in discussions with your reasoning.

Note: Our shared goal is not to have the longest list of items. Our goal is to maintain a list of the most relevant resources for today.

Discussions

Use the Discussions section to talk about all sorts of topics related to this resource. For example: if you'd like help troubleshooting a PR, have a great new idea for how to improve this, or want to share something amazing you've learned in our docs, join us in the discussions.

Guidelines

  • The goal is to showcase the most relevant and useful resources.
    Adding every possible resource out there is not our goal. Imagine you are learning about formal verification in Web3 today, what would you ingest? Use your judgement to filter out the non-essential material.

  • Only add resources that you have personally evaluated
    Have you read that article? Did you complete this tutorial? Was the resource personally valuable to you? Honestly assess if this resource will also be valuable to the community.

  • PR Submissions

    If you are planning to contribute by adding resources, I recommend you to: (a) write meaningful commit messages and (b) look at the existing pull requests (and open discussions) before opening new ones.