Governance and Operations

Governance and Operations

DAO Responsibilities

Token Holders

yTeams

Multisig

Future Implementations

Read More

# Governance and Operations

Since YIP-61: Governance 2.0 (https://gov.yearn.fi/t/yip-61-governance-2-0/10460) passed on April 25th, 2021, yearn began the transition into a multi-DAO structure, managed by constrained delegation. This approach allows protocol development not to be stiffened by bureaucracy while maintaining a sufficient level of decentralization.

Multi-DAO refers to the fluid number of decentralized autonomous organizations (DAOs) that contribute to the protocol in some unique way. These independent groups consist of YFI holders, yTeams and the Multisig.

- YFI holders vote for changes to the protocol or the governance structure

- yTeams focus on specific aspects of the protocol or relevant operations

- Multisig members execute or veto any on-chain decisions

Token holders have an ultimate say over what yTeams exist, who is part of the Multisig, and the limitations of each group's operational control. The term 'constrained delegation' originates from token holders delegating specific powers to various groups building and managing yearn.

A simplified flow of governance would look like this:

- YFI holders create, destroy and define limitations of yTeams

- yTeam notifies yTx of a decision

- yTx creates a delegated transaction and send it to the Multisig

- Multisig executes or vetos the transaction

With veYFI (https://docs.yearn.fi/contributing/governance/veyfi) launch, governance moved from using YFI to veYFI as voting power.

## DAO Responsibilities

![""](https://i.imgur.com/IDysF5O.png)

### Token Holders

YFI (https://docs.yearn.fi/contributing/governance/yfi) token-holders duty is to create and vote for proposals that improve the protocol.

ProposalsDescriptionsYearn Improvement Proposal (YIP)A proposal to execute on any power delegated to YFI holders or outside the scope of enumerated powersYearn Delegation Proposal (YDP)A proposal to change where any discrete decision-making power is delegatedYearn Signaling Proposal (YSP)A non-binding proposal to signal community feelings or intent on any issue

Specifically, these proposals allow token holders to make the following decisions:

PowerDescriptionManage PowersYFI holders can vote to create, assign, or revoke discrete powers to or from yTeamsChange YFI Token ContractAny interaction with the YFI token contract, such as to mint YFI or burn the minting keys, remains under the control of YFI holders.Set FeesSet the standard fee structures in the Yearn ProtocolChange Multisig SignersAs the Multisig will continue to hold critical powers over the near term, only YFI holders can vote to change its signersRatify yTeamsFormally ratify or deratify yTeams to control which yTeams can hold delegated powersChange yOps SignersAs yOps has the power to change signers of other yTeams, this is a special power to change the signers of yOpsSpend Treasury FundsSpend funds from the treasuryYIP PowerYFI Holders have the power to propose a YIP on anything not already delegated

### yTeams

Each yTeam has an objective and discrete powers which are defined by token holders. yTeams can be broken into membership pools, separating groups of contributors working towards similar goals as the overarching team. Additionally, one membership pool can be a part of multiple yTeams.

yTeamObjectiveMembership PoolyGuardProtect the vaultsYFI Protocol Dev, YFI Strategists, YFI Mechanics, YFI Secret AdmirersyBrainManage the stratsYFI StrategistsyDevManage the protocolYFI Protocol DevyPeopleCurate the teamYFI Compensation Working Group, YFI AdvisorsyBudgetSpend money wellYFI Finances, YFI AdvisorsyFarmGrow the treasuryYFI Secret Admirers, YFI Secret EntranceyTxWrite transactionsYFI DoersyOpsCoordinate contributorsYFI Ops

Each yTeam is assigned specific decision-making powers, defined by YIP-61:

yTeamPowerDescriptionyGuardEmergency PowersImmediately intervene in case of attack or bug to shutdown or rollback strategies or vaultsyBrainManage StrategiesActivate, deactivate, tune, and maintain strategiesyDevDefine Yearn ProtocolDecide what code is considered part of yearn and what isn’tyDevManage ProtocolMaintain and improve the Yearn ProtocolyDevAdd StrategiesAdd new strategies to vaultsyTxDelegate TransactionsCreate delegated transactions for the multisig to sign and executeyPeoplePay TeamCreate, deploy, modify, or terminate Yearn compensation packagesyBudgetSet BudgetsCreate budgets for coordinape, grants, hiring, operations, or other workstreamsyFarmFarm TreasuryFarm with the treasury and make decisions on airdropsyOpsRatify yTeam SignersFormally approve or remove signers for each yTeam

### Multisig

Decisions issued by yTeams will be executed on-chain by the Multisig until a more decentralized system is approved for implementation. In the meantime, the Multisig (https://docs.yearn.fi/developers/security/multisig#members) controls the following:

PowerDescriptionExecution PowerThe power to execute decisions made by YFI holders and yTeams on-chainVeto PowerThis power allows the Multisig to veto any decision and ideally should not be neededTransitionary PowerA temporary power enabling the Multisig to operate under the mandate of YIP-41 until the set of decision-making powers covers all needed transactions

## Future Implementations

Yearn continuously paves the way towards an ideal balance of DAO decentralization and productivity. The current phase of efforts implements changes mainly on the social layer. In the future, we will be moving towards software implementations such as:

- Multisig consensus mechanisms that allow each yTeam to have execution power

- Move from proxy voting to on-chain voting

- tokenize decision-making powers as NFTs

- Utilize Coordinape (https://coordinape.com/) for things like budget allocation and compensation

## Read More

- Article (https://medium.com/iearn/yearn-governance-explained-proposals-yfi-token-and-execution-113ec86c3a3f) about yearn governance process and YFI token role in it


Proposal Repository

Proposal Repository

Approved

Implemented

Rejected

# Proposal Repository

Yearn Improvement Proposals (YIPs), Yearn Delegation Proposals (YDPs) and Yearn Signaling Proposals (YSPs) are all tools that token holders use to maintain and grow the protocol.

## Approved

NumberTitleAuthor34 (https://yips.yearn.fi/YIPS/yip-34)Add Synthetix (SNX) to yVaultsSubstreight (https://github.com/substreight)52 (https://yips.yearn.fi/YIPS/yip-52)Make Strategist Skin in Game Partner for Make Benefit of Glorious Brain of Yearnbanteg (https://github.com/banteg), lehnberg (https://github.com/lehnberg), milkyklim (https://github.com/milkyklim)65 (https://snapshot.org/#/ybaby.eth/proposal/0x8f7417fa5565d9f46e16618503e8808c36d51b2a9e8217a68c632d7c090d69d9)Evolving YFI Tokenomics (veYFI)0xJiji (https://gov.yearn.fi/u/0xjiji), banteg (https://github.com/banteg), daryllautk, HAtTip3675, onlylarping (https://gov.yearn.fi/u/onlylarping), vany365 (https://gov.yearn.fi/u/vany365), Wot_Is_Goin_On (https://gov.yearn.fi/u/wot_is_goin_on)

## Implemented

NumberTitleAuthor0 (https://yips.yearn.fi/YIPS/yip-0)YIP Purpose and GuidelinesYearn Community1 (https://yips.yearn.fi/YIPS/yip-1)Minting more YFIAndre Cronje (https://github.com/andrecronje)10 (https://yips.yearn.fi/YIPS/yip-10)Transitionary YFI Only VotingRewkang (https://github.com/rewkang)12 (https://yips.yearn.fi/YIPS/yip-12)Reducing the quorum for accepting proposalcp287 (https://github.com/illlefr4u)32 (https://yips.yearn.fi/YIPS/yip-32)Remove YFI burningSunil Srivatsa (https://github.com/alphastorm)33 (https://yips.yearn.fi/YIPS/yip-33)Add LINK to yVaultsfranklin (https://github.com/franklin501)35 (https://yips.yearn.fi/YIPS/yip-35)Distribute Donations vs Purchase YFIAndre Cronje (https://github.com/andrecronje),Klim K (https://github.com/milkyklim)36 (https://yips.yearn.fi/YIPS/yip-36)System rewards as operational capitalAndre Cronje (https://github.com/andrecronje), iTo, n00b (https://github.com/jchi18), Artem K (https://github.com/banteg)37 (https://yips.yearn.fi/YIPS/yip-37)Participate in CRV governance and 2.5x CRV reward boostAndre Cronje (https://github.com/andrecronje), Artem K (https://github.com/banteg)38 (https://yips.yearn.fi/YIPS/yip-38)Distribute / Keep Balancer RewardsKlim K (https://github.com/milkyklim)39 (https://yips.yearn.fi/YIPS/yip-39)Add Curve sBTC Pool LP-Tokens yVaultuhmpeps (https://github.com/az)40 (https://yips.yearn.fi/YIPS/yip-40)Replace inactive multisig signerscp287 (https://github.com/illlefr4u), Artem K (https://github.com/banteg)41 (https://yips.yearn.fi/YIPS/yip-41)Temporarily Empower Multisigtracheopteryx (https://github.com/tracheopteryx), Joe Mahon (https://github.com/Substreight), franklin501 (https://github.com/franklin501), Michael Anderson, Vance Spencer44 (https://yips.yearn.fi/YIPS/yip-44)Improve YIP categoriessam bacha (mailto:sam@freighttrust.com)45 (https://yips.yearn.fi/YIPS/yip-45)Add a bounty for proposing YIPs that are implementedSunil Srivatsa (https://github.com/alphastorm)51 (https://yips.yearn.fi/YIPS/yip-51)Set Vault v2 Fee Structurebanteg (https://github.com/banteg), lehnberg (https://github.com/lehnberg), milkyklim (https://github.com/milkyklim), tracheopteryx (https://github.com/tracheopteryx)54 (https://yips.yearn.fi/YIPS/yip-54)Formalize Operations Fundingbanteg (https://github.com/banteg), lehnberg (https://github.com/lehnberg), lex_node (https://github.com/lex-node), milkyklim (https://github.com/milkyklim), tracheopteryx (https://github.com/tracheopteryx)55 (https://gov.yearn.fi/t/yip-55-formalize-the-yip-process/7959/7)Formalize the YIP Processfranklin (https://github.com/franklin501)56 (https://snapshot.org/#/yearn/proposal/Qmb6gBzjvgLMazSrQQGVcjutLNdkVyM2Lh6yckMzdoaHWZ)BABY: Buyback and Buildlex_node (https://github.com/lex-node), tracheopteryx (https://github.com/tracheopteryx), Artem K (https://github.com/banteg), Klim K (https://github.com/milkyklim), Ryan Watkins (https://twitter.com/RyanWatkins_), lehnberg (https://github.com/lehnberg)57 (https://snapshot.org/#/yearn/proposal/QmX8oYTSkaXSARYZn7RuQzUufW9bVVQtwJ3zxurWrquS9a)Funding Yearn's Futurealeks-blockchaincap (https://gov.yearn.fi/u/aleks-blockchaincap/summary), Artem K (https://github.com/banteg), dudesahn (https://twitter.com/dudesahn), ekrenzke (https://gov.yearn.fi/u/ekrenzke), lehnberg (https://github.com/lehnberg), Klim K (https://github.com/milkyklim), Ryan Watkins (https://twitter.com/RyanWatkins_), srs-parafi (https://gov.yearn.fi/u/srs-parafi/summary), tracheopteryx (https://github.com/tracheopteryx), vooncer (https://gov.yearn.fi/u/vooncer/summary), yfi-cent (https://gov.yearn.fi/u/yfi-cent/summary)59 (https://snapshot.org/#/yearn/proposal/QmdRCXH6BQpNcucoZqAtS5hQKjckE2428qiZoWjxmJXbs3)Temporarily extend Multisig empowermentlehnberg (https://github.com/lehnberg)60 (https://snapshot.org/#/ybaby.eth/proposal/QmNqAqRKMFcoRjaRYAKCVETij6sjJ4S1293kbpYDMVvcjB)Airdrops to Yearn Vaultslehnberg (https://github.com/lehnberg)61 (https://snapshot.org/#/ybaby.eth/proposal/QmSMyYeKrRpnA7Xn56o2NtbCUzxmhzCupL7LxMA1reXxq4)Governance 2.0tracheopteryx (https://github.com/tracheopteryx), lex_node (https://github.com/lex-node)62 (https://snapshot.org/#/ybaby.eth/proposal/QmddCbGYbkooZ1zp8oYnbBz6frXLRc9xbkapXcuZcdzmMF)Change Two Multisig Signerstracheopteryx (https://github.com/tracheopteryx), banteg (https://github.com/banteg), lehnberg (https://github.com/lehnberg), milkyklim (https://github.com/milkyklim)63 (https://snapshot.org/#/ybaby.eth/proposal/QmPK9AqeoV6v5xeuiTeFcj9Px7y87KMQ1gGhvHft2GMtqE)Fund Builder-First Legal Activism DAOAndre Cronje (https://github.com/andrecronje), tracheopteryx (https://github.com/tracheopteryx), lex_node (https://github.com/lex-node), Judge Jowday (https://twitter.com/judge_jowday), S. Brennan (https://twitter.com/SH_Brennan), Birdman_Haxxor (https://twitter.com/Birdman_Haxxor)66 (https://yearn.snapshot.page/#/proposal/0x804d3765e70d6e4f0f0a225222dadd396cd328595d5fd097b732b36fdf8e6af6)Streamlining contributor compensation0xJiji (https://gov.yearn.fi/u/0xjiji) + 14 authors from the Compensation group67 (https://snapshot.org/#/ybaby.eth/proposal/0xd1988feec955cb93d42b63b7b4845d35da8f60859f55ec18b3d5609ecd4eb9e2)Contribute to the Nomic FoundationFrancoNomic (https://gov.yearn.fi/u/franconomic/summary)68 (https://snapshot.org/#/ybaby.eth/proposal/0xc5386b7237f6c90359c56ac6dcb942b99a56a4de8ca60d109f4b999716148734)Rotate multisig signersbanteg (https://github.com/banteg)69 (https://snapshot.org/#/ybaby.eth/proposal/0xe4c2c990eaf4bb4a7a8031c461f5db820bae08fd7b81441d56e8cc0378c44afe)Reduce and cap fees through yRates0xJiji (https://gov.yearn.fi/u/0xjiji), banteg (https://github.com/banteg), flashfish, jiji, jmonteer, newmickymousse, saltyfacu, wavey

## Rejected

NumberTitleAuthor2 (https://yips.yearn.fi/YIPS/yip-2)Burn YFI for feesAndre Cronje (https://github.com/andrecronje)5 (https://yips.yearn.fi/YIPS/yip-5)Reducing YFI weekly supplyDamir Bandalo (https://github.com/sikiriki12)8 (https://yips.yearn.fi/YIPS/yip-8)Halving YFI weekly supply the same as bitcoinsteamer.eth14 (https://yips.yearn.fi/YIPS/yip-14)Yearn Rewards ReserveYieldBouncer (https://github.com/yieldbouncer)30 (https://yips.yearn.fi/YIPS/yip-30)YFI Inflation ScheduleSubstreight (https://github.com/substreight), DeltaTiger (https://github.com/deltatigernz), Hannes Graah (https://github.com/Graadient), Daryl lau (https://github.com/Daryllautk), yfi_whale31 (https://yips.yearn.fi/YIPS/yip-31)YFI Inflation DistributionSubstreight (https://github.com/substreight), DeltaTiger (https://github.com/deltatigernz), Hannes Graah (https://github.com/Graadient), Daryl lau (https://github.com/Daryllautk)42 (https://yips.yearn.fi/YIPS/yip-42)Add RenBTC to yVaultsAzeem (https://github.com/zu-ctrl)43 (https://yips.yearn.fi/YIPS/yip-43)Improve YIP categoriesSam Bacha (mailto:sam@freighttrust.com)64 (https://yips.yearn.fi/YIPS/yip-43)Adjust fees on non-stablecoin yVaultswavey, philbert, saltyfacu

For current proposals, please visit Snapshot (https://snapshot.org/#/ybaby.eth)


Writing Style Guide

Writing Style Guide

Writing Intent and Tone

Writer Guidelines

General Rules

Abbreviations

Acronyms, Decades and Cases

Acronyms

Decades

Capitalize

Title Case

Currencies

Cryptocurrencies

Yearn

Numbers

Lists

Links

Tables of Contents

Markdown Guide

Best Practices and Resources

Learn the Basics of Markdown

Helpful Writing Tools

Text Editors

Word Choice

Review Community Guides

Document-Specific Maintenance Guides

Contributor Tools

Express Interest

Collaborate

Track Progress

Final Drafts and Submissions

Acknowledgements

# Writing Style Guide

The Yearn Community Writing Style Guide summarizes the standards and best practices writers should follow when contributing to Yearn Documentation resources.

## Writing Intent and Tone

Yearn Community materials should cater to readers who are unfamiliar with the Yearn ecosystem. Writers should also assume that their readers have tight schedules and short attention spans, as after all, farming is honest but hard work.

As such, Writers should focus on communicating concepts as clearly and succinctly as possible.

- Use simple language.

- Use short, concise sentences.

- Avoid unnecessary words.

- Remain open and objective.

- Provide examples when possible.

- Provide examples to help explain concepts, but avoid overcomplicating them.

- Use math when necessary, but keep it simple and visually easy to understand.

- Link to basic terms if necessary.

## Writer Guidelines

### General Rules

- Run all drafts through Grammarly (https://app.grammarly.com/) regularly, and before final submissions.

- Grammarly will catch most spelling and grammatical errors.

- Copy rendered text into Grammarly and address any mistakes it flags.

- HackMD does not identify spelling and grammatical errors.

- Grammarly will miss errors if it’s given raw Markdown text.

- Be careful of copy and pasting code from Grammarly to VScode, Grammarly may mess with formatting.

Please Note

- When migrating to a new document (i.e., from Google Docs to HackMD):

- Leave a note in the old file.

- Provide a link to the latest version.

- Do not blindly accept Grammarly suggestions.

- Review edits to make sure they make sense.

Use:

- Oxford commas (https://en.wikipedia.org/wiki/Serial_comma).

- Pluralized, gender-neutral pronouns (https://en.wikipedia.org/wiki/Singular_they).

- Use “they/their” instead of “he/she/his/hers.”

- Examples: “When they…” or “If users choose to X, then their…”

- The `%` symbol. Do not spell out "percent."

- Correct: 15%

- Incorrect: 15 percent

- Double quotes `" "` for phrases, quotes, etc.

- Do not use single `' '` quotes.

Avoid:

- First-person language. (https://en.wikipedia.org/wiki/Grammatical_person)

- Examples: I, we, our, etc.

- Second-person language (https://en.wikipedia.org/wiki/Grammatical_person) (unless it is appropriate for a guide or action page).

- Examples: "You then..." or "Now you should..."

- Exclamation points.

- Footnotes.

- References to deprecated names for Yearn Components.

- Examples: yyCRV or yUSD instead of yvCurve-Y

- Parentheses for stating additional information

- Incorrect: Development Grants are larger sized (5,000to5,000 to 5,000to50,000) grants aimed at individuals or teams building projects around vaults and the broader Yearn ecosystem.
Correct: Development Grants are generally larger sized grants, ranging from 5,000to5,000 to 5,000to50,000, aimed at individuals or teams building projects around vaults and the broader Yearn ecosystem.

### Abbreviations

Use parentheses to define abbreviated terms the first time they appear in a given document.

Example: A Yearn Improvement Proposal (YIP) is a proposal framework to support new initiatives and to expand the scope of existing ones.

### Acronyms, Decades and Cases

Do not use apostrophes to pluralize acronyms or indicate decades. Add an "s" at the end.

#### Acronyms

To make an acronym plural:

Correct: YIPs
Incorrect: YIP's

#### Decades

To indicate a decade:

Correct: 1990s
Incorrect: 1990's

#### Capitalize

Names and proper nouns.
Cities, countries, nationalities, and languages.
Terms with definitions provided by Yearn.

#### Title Case

The Title Case Converter will keep titles consistent.

- Follow the New York Times standard.

- Capitalize the first and last words, all nouns, pronouns, verbs, adverbs, and adjectives.

- Lowercase all articles, conjunctions, and prepositions.

### Currencies

The examples below use dollars, but the same rules apply to all global currencies.

- Use lowercase except when writing "US Dollar.”

- Use figures and the "$" sign in all except casual references, or amounts without a figure.

- Standard: "The book costs $4."

- Casual: "Please give me a dollar."

- For amounts under $1 million, follow this format:

- Correct: 4,4, 4,25, 500,500, 500,1,000, $650,000.

For amounts over $1 million, use the word, not numerals.

Correct: "He is worth $4 million."
Incorrect: "He is worth $4,000,000."

#### Cryptocurrencies

When directly referring to the creation, destruction, or manipulation of a token (particularly as it relates to tooling) or when referencing the token as a currency, in an instructional or conversational setting, or as a conceptual product of the Foundation or its systems:

Use the proper prefix if necessary and capitalized TLA version: wETH
Example: “wETH is a token that represents Ether 1:1 and conforms to the ERC20 token standard.”

Similarly, when referring to exchange pairs:

Use: wETH/DAI

#### Yearn

When referring to Yearn as a smart contract system, use "The Yearn Protocol."

Example: “The Yearn Protocol is a set of contracts for yield optimization."

When referring to Yearn as a body of YFI voters and the general stakeholder community, use "Yearn Community" or simply "Yearn."

Example: "Yearn passed a vote to decrease the yCRV vault performance fee."
Example: "The Yearn Community passed a vote to add an additional vault."

Use "Yearn" for casual references to Yearn and the Yearn Protocol as a whole.
When referring to an audit assessment report follow the Audit Citation Guidelines

### Numbers

- Spell out numbers below 10.

- Examples: one, two, three, etc.

- Use numerals for numbers above 10, unless starting a sentence.

- For numbers with million, billion, or trillion, use figures in all except casual cases.

- Standard: "The nation has 1 million citizens."

- Casual: "I'd like to make a billion dollars."

### Lists

When bulleted and numbered lists contain complete sentences, capitalize the first word, and follow each with a period. If list items are phrases, no capitalization or punctuation is required.

- Don't use a list with only 1 item.

- Use parallel construction (https://en.wikipedia.org/wiki/Parallelism_%28grammar%29) for each item in a list.

- Start with the same part of speech (https://en.wikipedia.org/wiki/Part_of_speech) for each item (in this case, a verb).

- Use the same verb tense (https://en.wikipedia.org/wiki/Grammatical_tense#English) for each item.

- Use the same voice (https://en.wikipedia.org/wiki/Voice_%28grammar%29) for each item.

- Use the same sentence type (statement, question, exclamation) for each item.

- List items that include definitions should look like this:

- Team: Yearn Protocol Developers and Contributors

- Community: General participants in Yearn forums and chat

- Use dashes rather than asterisks for unordered lists.

- Correct: `-`

- Incorrect: `*`

- Alphabetize lists of names unless there is a clear priority at work.

- Do not use ordered (numbered) lists unless order matters.

- Ordered list items should use the `1.` repeated.

- Markdown will automatically generate numbers.

Example:

```
1. Item 11. Item 21. Item 31. Item 3a1. Item 3b
```

### Links

- Use absolute links (https://docs.microsoft.com/en-us/contribute/how-to-write-links) and standard web URLs when referencing external resources.

- Create descriptive hyperlinks and avoid generic language.

- Correct - Descriptive: Learn more at Yearn Documentation (https://docs.yearn.fi/)

- Incorrect - Generic: Learn more here (https://docs.yearn.fi/).

- Include a `.`outside the link for sentences that end with a link.

- When creating links for parallel translated documents, make sure to update relative links to reflect the correct heading.

### Tables of Contents

- Include a table of contents for documents that span several pages and multiple sections.

- Use the raw Markdown from the Table of Contents above as a template.

- Be sure to include the line breaks `---` as well to keep formatting consistent.

- The table of contents should list relevant sections for easy navigation.

## Markdown Guide

Yearn documents posted on GitHub are written in Markdown, a text-to-HTML conversion tool for web writers.

- Include line breaks above and below headings.

- Use top-level headers (`#`) only once per document.

- Do not make multiple top-level headings.

- Avoid repeat headings.

- They will break auto-generated navigation.

- Avoid trailing spaces.

- Do not use:

- Em or en dashes: (https://en.wikipedia.org/wiki/Wikipedia:Hyphens_and_dashes) `—`

- Ampersands `&` in titles and headers.

- Pipes `|` in titles and headers.

- Curly quotes. Use the plaintext version.

- Correct: `"`

- Incorrect: `“`

- Escaping parentheses. Use normal parentheses.

- Correct: `(SOMETHING)`

- Incorrect: `\(SOMETHING\)`

- Ensure there is a single hard return at the end of a .md file.

- Use emojis to call attention to an important point, when necessary.

- Practice discretion and use them sparingly.

- This cheat sheet (https://gist.github.com/rxaviers/7360908) lists emojis and their Markdown shortcuts.

## Best Practices and Resources

Writers and contributors familiar with Yearn and cryptocurrency basics will have a better sense of where to apply their skills best.

- Spend some time learning about Yearn's function, history, and any recent events before contributing.

- In-depth knowledge is appreciated but not required.

### Learn the Basics of Markdown

- Daring Fireball (https://daringfireball.net/projects/markdown/)

- Markdown Syntax Guide (https://guides.github.com/features/mastering-markdown/)

- Practice Communicating Using Markdown (https://lab.github.com/githubtraining/communicating-using-markdown)

### Helpful Writing Tools

Make use of any writing tools that help improve workflow and writing quality. See the list below for some recommendations.

#### Text Editors

- Grammarly (https://app.grammarly.com/) - Mistake-free writing editor

- HemingwayApp (https://www.hemingwayapp.com/) - Make writing bold and clear

#### Word Choice

- Thesaurus (https://www.thesaurus.com/) - Synonyms

- Powerthesaurus (https://www.powerthesaurus.org/) - Synonyms and phrase suggestions

- WordHippo (https://www.wordhippo.com/) - Synonyms and phrase suggestions

### Review Community Guides

Review the respective Contribute.md for each repository where pertinent before starting work on any Yearn project.

- Yearn contributor guides outline writing standards and help simplify the writing process.

#### Document-Specific Maintenance Guides

- Check for an associated maintenance guide before starting work on a given document if applicable.

- A document maintenance guide outlines standards to help Reviewers and contributors when maintaining a given resource.

- The rules described within a document-specific maintenance guide supersede other guides.

- If a discrepancy is glaring or unreasonable, bring the issue to an admin in the #documentation (https://discord.gg/freT6YRNSX) channel on Yearn's discord.

#### Contributor Tools

- The Contributor Tools Guide (https://docs.yearn.fi/contributing/contributor-tools) guide introduces the tools regularly used by Yearn contributors.

### Express Interest

- Check out the Getting Started guide for contributing to Documentation.

- Join the #documentation (https://discord.gg/freT6YRNSX) channel on Yearn's Discord, read the pinned messages, and reach out to a channel admin.

- Yearn community team members and senior contributors help onboard new contributors via Discord or Telegram chats where applicable.

- Feel free to discuss personal interests and relevant skills to help determine a well-suited project/issue and jump right in.

- To understand strengths you can also provide relevant examples of past projects, work, and experience.

- Demonstrate a reliable work ethic and offer quality work that speaks for itself.

- Stand out by suggesting projects and adding insight to public discussions.

### Collaborate

- When accepting an assignment, be sure to collaborate early and often.

- Visit #documentation (https://discord.gg/freT6YRNSX) or corresponding Telegram chat regularly.

- Coordinate with other members.

- Ask as many questions as necessary

- Ask for feedback when stuck.

- Provide frequent progress updates.

- Develop a plan that defines an approach for an assignment.

- Produce a project outline. Clarify the what so we can agree on the how.

- Set achievable deadlines. Timeboxing is good :)

- Assign and divide tasks with other contributors.

- Multiple contributors should not start work on similar projects individually. Please check that the same issue does not already exist in the GitHub Issues for that Repository, and if it does please coordinate with whoever is working on it to divide the work if needed.

#### Track Progress

- Track projects and progress with clear GitHub commit messages

#### Final Drafts and Submissions

- Transfer approved final drafts from Google Docs to HackMD or DrawIO(for diagrams) if need be.

- Let the team know when a project is ready for final review by moving your issue to the status of `Pending Review` on GitHub and messaging in the appropriate Discord or Telegram channel.

- Once reviewed, submit completed projects for approval as a Pull Request (https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) on GitHub.

- Ensure to update any relevant issues and the project board on GitHub

### Acknowledgements

This document could not be possible without the amazing work done by the MakerDAO team as this document is mostly based on their Writing Style Guide (https://github.com/makerdao/community-portal/blob/r2d/content/en/contribute/content/writing-style-guide.mdx).


How to contribute to docs

How to contribute to docs

Working with HackMD

Editing through the documentation UI

Cloning the docs repository

# How to contribute to docs

IF YOU HAVE ANY QUESTIONS post in the #documentation channel on discord (https://discord.gg/freT6YRNSX)

Yearn's documentation repository is hosted on GitHub in order to foster and encourage open source collaboration.

Note for translators: Non-english docs are stored in separate branches. When merging your changes, direct your pull request to the corresponding branch

## Working with HackMD

In order to contribute to Yearn docs, you will need to be able to write with Markdown syntax. It's extremely easy to learn. Use this cheat sheet (https://www.markdownguide.org/cheat-sheet/) to get started.

If you have no experience cloning and working on a repository, you can make your edits or additions in HackMD (https://hackmd.io) and then create an issue in GitHub that contains the Markdown copy. Just create a profile on Discord, and that can be linked to create a HackMD account.

Here's how to contribute using issues:

-

Create an issue in https://github.com/yearn/yearn-devdocs

![""](https://i.imgur.com/m4J2vKh.jpg)

-

Title your proposed changes - Make it clear what you are editing or adding

-

Paste the changes directly from your HackMD into the 'Write' section

-

Click 'Submit new issue'

![""](https://i.imgur.com/fbvUX1t.jpeg)

## Editing through the documentation UI

Another simple way to contribute is through the built in 'Edit on GitHub' button that you will see on all pages of Yearn docs. For this, you won't need to use HackMD at all, just make sure to have a GitHub account.

-

Find the 'Edit on GitHub' button on the top right of the docs page.

![""](https://i.imgur.com/raB4DUB.jpg)

-

Find the pencil button on the GitHub page that opens. It will say 'Edit the file in your fork of this project'

![""](https://i.imgur.com/boWmvln.jpg)

-

From here, you will be able to edit any of the copy. Once you're finished, give your changes a title and a description at the bottom and 'Propose Changes'

![""](https://i.imgur.com/oESKgwx.jpg)

-

After you 'Propose changes' GitHub will create a branch of the yearn-devdocs repository for you and show a summary of the changes you made. If everything looks right and complies with the Writing Style Guide (https://docs.yearn.fi/contributing/documentation/writing-style-guide), click 'Create pull request'

-

In your pull request (PR), give enough context about your changes for the repo admin to understand why they should be accepted. Afterwards, click 'Create pull request' and the admins will either merge, deny or make a comment.

![""](https://i.imgur.com/iTGJanv.jpeg)

## Cloning the docs repository

Cloning a repository is ideal if you are working on more than one page.

This is a basic guide that doesn't involve using the command prompt. There are multiple ways to go about cloning and contributing to a repository. We encourage you to learn more about GitHub as it will help you troubleshoot any issues that you might encounter.

-

Login to your GitHub account

-

Install GitHub Desktop (https://desktop.github.com)

-

Install Visual Code Studio (https://code.visualstudio.com) (VSCode)

-

Fork the yearn/yearn-devdocs (https://github.com/yearn/yearn-devdocs) repository

![""](https://i.imgur.com/vVpFt7a.jpeg)

-

Login to GitHub Desktop, find your forked repository and clone it

![""](https://i.imgur.com/7ycrC2F.jpg)

-

Click 'contribute to parent project'. This only effects your upstream and origin and upstream branch, which can be edited through the command line

-

Open the repository in VSCode

![""](https://i.imgur.com/Q0jWQic.jpg)

-

Create a new branch and give it a title that has to do with your current task. Keeping different tasks in different branches is important for organizational purposes

-

Find the page you are looking to edit in VSCode's sidebar. They follow the same structure as the Docs UI. README.md will always be

![""](https://i.imgur.com/dIfrmfU.png)

-

Edit the .md file, save it and minimize VSCode

-

GitHub Desktop will now show that you have changed a file. Give your change (commit) a title and description, then click 'commit to master'

![""](https://i.imgur.com/XE2Ghim.jpg)

-

Now, your changes are committed to your local branch. In order to push them to your public GitHub repo, click 'publish branch'

-

You now see a notification suggesting to make a pull request (PR) both on GitHub Desktop and the website. If you don't see this, you can go to https://github.com/yearn/yearn-devdocs and create one from there

-

Click on 'create pull request' and you should see the following screen

![""](https://i.imgur.com/r8JuC84.jpg)

-

Make sure the base repository is 'yearn/yearn-devdocs' and the base is 'master'. (unless you are contributing to translated versions, in which case, the base should be the name of the language you are translating) The head repository should be 'your-username/yearn-devdocs' and the compare should be 'your-branch-name'

-

Make sure that your PR has all of the information needed to contextualize the change and that your changes comply with the Writing Style Guide (https://docs.yearn.fi/contributing/documentation/writing-style-guide). Once you create a pull request, it will be sent to the repo admins who can approve it to be merged into the live site.