How to contribute to Open-Cadence?

Contributing to Open Cadence is easy! And we’d love for you to share your work with the community so that we can keep on benefiting from each others work and keep creating amazing projects on Flow!

In order to contribute, we’ve tried to make it as easy as possible to add an example to the website. We provide you the format for submitting a pull-request to this GitHub repo so that your example can be added. We’ll go over the format for submitting your example in the following section!

https://github.com/onflow/open-cadence

Adding an Example to Open Cadence Format

In order to submit an example to the Open Cadence GitHub, you will need to submit a pull request in line with the following format in order to get it merged to the site. The format is as follows.

• Navigate to the ‘modules’ folder in the ‘src’ folder in the repository

  • Here you will see all of the examples that are available on open cadence, and you can start to get an idea of how you will structure your folders to be approved

    

• Add a new folder in the ‘modules’ folder with the name of your Cadence example

  • Name it something that identifies what your example is about so that it’s easy to maintain

• In your newly created folder, create an ‘index.js’ file as well as two folders, one named ‘cadence’ and one named ‘description’

  • Tip: Just copy the contents inside one of the already existing folders in the modules folder

• Within the ‘cadence’ folder you will have four files with the following names

  • contract.js
  • contractExplain.js
  • transaction.js
  • transactionExplain.js

• In each of these folders, you will input the text for the necessary parts of the contract and explanation that is needed. You can see in the example below how each const is created

export const contract = `pub resource interface Provider {

    // withdraw
    //
    // Function that subtracts tokens from the owner's Vault
    // and returns a Vault resource (@Vault) with the removed tokens.
    //
    // The function's access level is public, but this isn't a problem
    // because even the public functions are not fully public at first.
    // anyone in the network can call them, but only if the owner grants
    // them access by publishing a resource that exposes the withdraw
    // function.
    //
    pub fun withdraw(amount: UFix64): @Vault {
        post {
            // 'result' refers to the return value of the function
            result.balance == UFix64(amount):
                "Withdrawal amount must be the same as the balance of the withdrawn Vault"
        }
    }
}
`

• In the description folder you will create on file called ‘description.js’
• In this file you will have variables that you will assign that will be used for constructing the example
  • Name - Name of your example
  • Description - A brief description of what your example is about
  • Playground Link- A Playground Link that shows what your example does in real time
  • Category - The category your example falls under. Feel free to use an existing one or create your own if needed
  • Icon - The icon for your example. Open Cadence uses the fortAwesome library for Icons, so please use an icon from there
  • bgColor- The bgColor of the thumbnail. Please try to use one that is not similar to the previous ones
  • Script - If the interaction code with your smart contract is a script, please label this as ‘true’, if it is a transaction label this as ‘false’