From 19b3ccb40829c28c3b1664c9a581925acc229992 Mon Sep 17 00:00:00 2001 From: nomadyfi <71185416+nomadyfi@users.noreply.github.com> Date: Tue, 17 Nov 2020 20:29:30 -0600 Subject: [PATCH 1/5] Update Contribution Guide --- contributors/README.md | 50 +++++++++++++++++++++--------------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/contributors/README.md b/contributors/README.md index 56ab9c73..eb177006 100644 --- a/contributors/README.md +++ b/contributors/README.md @@ -2,35 +2,41 @@ ## Yearn Contributors -Help build the future of finance, today. Shape your skills, help others, and help grow the Yearn ecosystem. If it’s not fun, we’re not doing it right. If you are interested in finding out a bit more of what Yearn means for builders see the [Yearn manifesto](https://gov.yearn.finance/t/how-we-think-about-yearn/7137). +Help build the future of finance, shape your skills, and grow the Yearn ecosystem. Before joining our community, take some time to understand the philosophy behind Yearn through the [Yearn Manifesto](https://gov.yearn.finance/t/how-we-think-about-yearn/7137). ## How to Contribute ### Have an idea? -We are always open to new suggestions or better ways of doing things. If you have an idea feel free to use the appropriate channel on [Discord](http://discord.yearn.finance), [Reddit](https://www.reddit.com/r/yearn_finance/), or make a post on [forum](https://gov.yearn.finance/c/general-chat/7). If the idea has been thoroughly thought through – make a post in [Proposals](https://gov.yearn.finance/c/proposals/5]) section on forum – adhere to the Proposal [Guidelines](https://gov.yearn.finance/t/proposal-how-to/106). Check previous [YIPs](https://yips.yearn.finance/all-yip) for guidance. +We are always open to new suggestions or better ways of doing things. If you have an idea feel free to use the appropriate channel on [Discord](http://discord.yearn.finance), [Reddit](https://www.reddit.com/r/yearn_finance/), or make a post on the governance [forum](https://gov.yearn.finance/c/general-chat/7). If the idea is thorough enough, make a post in the [Proposals](https://gov.yearn.finance/c/proposals/5]) section on the governance forum and be sure to follow the Proposal [Guidelines](https://gov.yearn.finance/t/proposal-how-to/106). Check previous [YIPs](https://yips.yearn.finance/all-yip) for guidance. ### File a Bug -If yearn product isn't working like you think it should please visit the appropriate Github repository listed in the [General Resources](##general-resources) section below or search in the [Yearn Github Repo](https://github.com/iearn-finance/yearn-protocol) if the issue already exists. If it does not exist please create a new issue following the issue template present in the repository(repo). If no issue template is present please include enough information such as your browser version, device, etc for that project so that the developers can replicate it and fix it. If the issue already exists you can signal your support by adding a thumbs up to the already existing issue or add any additional helpful information. +If a Yearn product isn't working, please visit the appropriate Github repository listed under [General Resources](#general-resources) — or search in the [Yearn Github Repo](https://github.com/iearn-finance/yearn-protocol) — to see if the issue already exists. -### Leave Feedback +If it does not exist, please create a new issue following the template present in the repository. -Use [yGov Forums - Feedback](https://gov.yearn.finance/c/feedback/2) to leave feedback. +If no issue template is present, please include information such as your browser version, device, etc. for that project so the developers can replicate it and fix it. + +If the issue already exists, you can signal your support by adding a thumbs up to the existing issue or by adding helpful information. + +### Feedback + +Use the [Feedback](https://gov.yearn.finance/c/feedback/2) section of the governance forum to provide feedback. ### Write Documentation -The Yearn ecosystem is expanse and the need to document it is ever-growing. The Yearn Documentation can be seen at the official [Yearn Docs](https://docs.yearn.finance/) page and it includes everything from High-Level Documentation regarding Yearn itself to more product specific and technical explanations. +The Yearn ecosystem is expanding and, as a result, so is the need for documentation. You can find the "official" Yearn Documentation [here](https://docs.yearn.finance/) — which provides high-level overviews *and* technical documentation. -Whether you are interested in writing _How To_ guides on how vaults work for the layperson or creating diagrams on how the entire protocol ties together, there is something for everyone. If languages are your _forté_, then translations might be up your alley as Yearn wishes to reach everyone regardless of their native language. +Whether its writing _How To_ guides on using vaults or creating diagrams on how the protocol ties together, there is something for everyone. If speak another language, translations might be up your alley! -You can see our ongoing progress on the [Github Project Board](https://github.com/orgs/iearn-finance/projects/2) where you can look through any issue which interests you. In order to begin contributing please see our [How to Use Github](https://hackmd.io/4U35op0ORoGT24lzPhbGNQ) guide and begin contributing by submitting a PR adhering to our [Writing Style Guide](https://hackmd.io/dXQecpkJQX6XRy4y7k7j3g). +You can see our progress on the [Github Project Board](https://github.com/orgs/iearn-finance/projects/2) where you can look through any issue that interests you. Before contributing: Please see our [How to Use Github](https://hackmd.io/4U35op0ORoGT24lzPhbGNQ) guide and ensure that your PRs adhere to our [Writing Style Guide](https://hackmd.io/dXQecpkJQX6XRy4y7k7j3g). -We use a combination of HackMD, Gitbook, and Github for our [Documentation](https://docs.yearn.finance/). In order to contribute to our diagrams & schemas we use [DrawIO](https://draw.io) in conjunction with Google Drive for versioning. If you are a grammar stickler you can see our [Reviewer Guide](https://hackmd.io/juTKNn3xTpKJgFDo2AglLw). +We use a combination of HackMD, Gitbook, and Github for our [Documentation](https://docs.yearn.finance/). To contribute to our diagrams & schemas we use [DrawIO](https://draw.io) in conjunction with Google Drive for versioning. If you are a grammar stickler you can see our [Reviewer Guide](https://hackmd.io/juTKNn3xTpKJgFDo2AglLw). -You can also join us over at #documentation channel on [Discord](https://discord.com/invite/6PNv2nF) and introduce yourself. +Last, but not least, join on the #documentation channel in [Discord](https://discord.com/invite/6PNv2nF) and introduce yourself. -If this is a bit too confusing right now don't worry about it, please let us know what we can clear up, and in the meantime, you can begin contributing to those HackMD docs immediately from those Github issues and we'll guide you through the rest. +If this sounds confusing, please let us know what we can clear up. In the meantime: You can begin contributing to those HackMD docs immediately via the Github issues — we'll guide you through the rest. ### Build @@ -40,31 +46,25 @@ If this is a bit too confusing right now don't worry about it, please let us kno - [Developer Team List](https://docs.yearn.finance/additional-resources/team#protocol-and-development) -If you are a developer we need your help! Before you begin you can familiarize yourself with Yearn, its products, and its infrastructure by reading our [Documentation](https://docs.yearn.finance/). +If you are a developer we need your help! Before you begin: Familiarize yourself with Yearn, its products, and its infrastructure by reading our [Documentation](https://docs.yearn.finance/). -You can additionally see our ongoing progress on our [Github Project Board](https://github.com/orgs/iearn-finance/projects/1) and you can immediately begin contributing where you see fit for anything that's tagged as `help wanted` as long as you stick to the respective repository's `Contribute` page with its coding guidelines (linting, formatting, PRs, etc) It's that simple 🙂. You can also join us over at the #dev channel on [Discord](https://discord.com/invite/6PNv2nF) if that's more your thing. +You can see our progress on our [Github Project Board](https://github.com/orgs/iearn-finance/projects/1) and you can immediately begin contributing where you see fit. We recommend checking out issues tagged as `help wanted` and be sure stick to the respective repository's coding guidelines (linting, formatting, PRs, etc). It's that simple 🙂. You can also join us on the #dev channel in [Discord](https://discord.com/invite/6PNv2nF). -If you are interested in working on a particular project check out the list of Yearn products in the [General Resources](##general-resources) section below or if you want to directly check out our list of repos head on over to our [Docs: Code Repositories](https://docs.yearn.finance/developers/code-repositories). +If you are interested in working on a particular project, check out the list of Yearn products in the [General Resources](#general-resources) section below or check out our list of repos [here](https://docs.yearn.finance/developers/code-repositories). -If you want a general overview of how our various services interact with one another for Vaults please see the schema and accompanying descriptions at [Vaults Overview](https://docs.yearn.finance/developers/yvaults-documentation/vaults-overview). +If you want an overview on how our services interact with one another for Vaults, please see the schema and accompanying descriptions in the [Vaults Overview](https://docs.yearn.finance/developers/yvaults-documentation/vaults-overview). -If you are curious how **strategies** work, please check out [ETHOnline 🛠️ Yearn Strats 101](https://www.youtube.com/watch?v=4gwZk-IaMRs) from our Yearn Devs. To start writing a new Strategy of your own please visit [Yearn Starter Pack Repo](https://github.com/iearn-finance/yearn-starter-pack). +If you're wondering how **strategies** work, please check out [ETHOnline 🛠️ Yearn Strats 101](https://www.youtube.com/watch?v=4gwZk-IaMRs) — hosted by our Yearn Devs. To start writing a Strategy of your own, please visit the [Yearn Starter Pack Repo](https://github.com/iearn-finance/yearn-starter-pack). -If you are looking to integrate with Yearn please visit our [Integration Guide](https://docs.yearn.finance/developers/integration-guide) and make sure to check out our [Interface Documentation](https://docs.yearn.finance/developers/yvaults-documentation/vault-interfaces). - -Lastly, if something is missing here that you think would make this better please create an issue here or submit a PR :) +If you are looking to integrate with Yearn, please visit our [Integration Guide](https://docs.yearn.finance/developers/integration-guide) and check out our [Interface Documentation](https://docs.yearn.finance/developers/yvaults-documentation/vault-interfaces). #### Designers -If you are a UI/UX designer, animator, or graphic designer Yearn needs your help! - -Whether it is creating graphics to describe how our the Yearn systems such as strategies work, making Yearn easier to navigate, or simply adjusting misaligned text on our homepage, we welcome all designers aboard the Yearn ship. - -You can find us over on [Discord](https://discord.com/invite/6PNv2nF) at the #ui-ux channel to learn more. +We invite designers, animators, artists, and more to share your skills with the Yearn ecosystem! If you're interested in creating graphics that describe Yearn's systems, creating video explainers, fixing Yearn's UI/UX, or any other combination of things — hop into the #ui-ux channel or #media-resources channels in [Discord](https://docs.yearn.finance/developers/yvaults-documentation/vault-interfaces). ## Yearn Contributors -See our wonderful list of contributors and statistics of contributions to the Yearn ecosystem at [yContributors.finance](https://ycontributors.finance/). Get your name added to the list by contributing documentation, code, designs, or whatever you feel is necessary :) +See our wonderful list of contributors and individual contribution stats at [yContributors.finance](https://ycontributors.finance/). Get your name added to the list by contributing to documentation, code, designs, or whatever else you're interested in! ## General Resources From e49e72bc74628e0da9ffcf406f7199a604ab489d Mon Sep 17 00:00:00 2001 From: nomadyfi <71185416+nomadyfi@users.noreply.github.com> Date: Tue, 17 Nov 2020 20:32:59 -0600 Subject: [PATCH 2/5] Update --- contributors/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributors/README.md b/contributors/README.md index eb177006..4411c470 100644 --- a/contributors/README.md +++ b/contributors/README.md @@ -20,7 +20,7 @@ If no issue template is present, please include information such as your browser If the issue already exists, you can signal your support by adding a thumbs up to the existing issue or by adding helpful information. -### Feedback +### Leave Feedback Use the [Feedback](https://gov.yearn.finance/c/feedback/2) section of the governance forum to provide feedback. From e48430fb8ce8e1d776ed392c2ff3362d6e62d1bb Mon Sep 17 00:00:00 2001 From: nomadyfi <71185416+nomadyfi@users.noreply.github.com> Date: Tue, 17 Nov 2020 20:38:16 -0600 Subject: [PATCH 3/5] Update --- contributors/README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/contributors/README.md b/contributors/README.md index 4411c470..eb5ff2c5 100644 --- a/contributors/README.md +++ b/contributors/README.md @@ -28,15 +28,15 @@ Use the [Feedback](https://gov.yearn.finance/c/feedback/2) section of the govern The Yearn ecosystem is expanding and, as a result, so is the need for documentation. You can find the "official" Yearn Documentation [here](https://docs.yearn.finance/) — which provides high-level overviews *and* technical documentation. -Whether its writing _How To_ guides on using vaults or creating diagrams on how the protocol ties together, there is something for everyone. If speak another language, translations might be up your alley! +Whether its writing _How To_ guides on using vaults or creating diagrams on how the protocol ties together, there is something for everyone. If you speak another language, translations might be up your alley! You can see our progress on the [Github Project Board](https://github.com/orgs/iearn-finance/projects/2) where you can look through any issue that interests you. Before contributing: Please see our [How to Use Github](https://hackmd.io/4U35op0ORoGT24lzPhbGNQ) guide and ensure that your PRs adhere to our [Writing Style Guide](https://hackmd.io/dXQecpkJQX6XRy4y7k7j3g). -We use a combination of HackMD, Gitbook, and Github for our [Documentation](https://docs.yearn.finance/). To contribute to our diagrams & schemas we use [DrawIO](https://draw.io) in conjunction with Google Drive for versioning. If you are a grammar stickler you can see our [Reviewer Guide](https://hackmd.io/juTKNn3xTpKJgFDo2AglLw). +We use a combination of HackMD, Gitbook, and Github for our [Documentation](https://docs.yearn.finance/) and we use [DrawIO](https://draw.io) with Google Drive for our diagrams & schemas. If you are a grammar stickler, you can see our [Reviewer Guide](https://hackmd.io/juTKNn3xTpKJgFDo2AglLw). -Last, but not least, join on the #documentation channel in [Discord](https://discord.com/invite/6PNv2nF) and introduce yourself. +Last, but not least, join the #documentation channel in [Discord](https://discord.com/invite/6PNv2nF) and introduce yourself. -If this sounds confusing, please let us know what we can clear up. In the meantime: You can begin contributing to those HackMD docs immediately via the Github issues — we'll guide you through the rest. +If this sounds confusing, please let us know what we can clear up. In the meantime: You can begin contributing to our HackMD docs immediately via the Github issues — we'll guide you through the rest. ### Build @@ -46,13 +46,13 @@ If this sounds confusing, please let us know what we can clear up. In the meanti - [Developer Team List](https://docs.yearn.finance/additional-resources/team#protocol-and-development) -If you are a developer we need your help! Before you begin: Familiarize yourself with Yearn, its products, and its infrastructure by reading our [Documentation](https://docs.yearn.finance/). +If you're a developer we need your help! Before you begin: Familiarize yourself with Yearn, its products, and its infrastructure by reading our [Documentation](https://docs.yearn.finance/). -You can see our progress on our [Github Project Board](https://github.com/orgs/iearn-finance/projects/1) and you can immediately begin contributing where you see fit. We recommend checking out issues tagged as `help wanted` and be sure stick to the respective repository's coding guidelines (linting, formatting, PRs, etc). It's that simple 🙂. You can also join us on the #dev channel in [Discord](https://discord.com/invite/6PNv2nF). +You can see our progress on our [Github Project Board](https://github.com/orgs/iearn-finance/projects/1) and you can immediately begin contributing where you see fit. We recommend checking out issues tagged as `help wanted` and reccommend sticking to the respective repository's coding guidelines (linting, formatting, PRs, etc). It's that simple 🙂. You can also join us on the #dev channel in [Discord](https://discord.com/invite/6PNv2nF). -If you are interested in working on a particular project, check out the list of Yearn products in the [General Resources](#general-resources) section below or check out our list of repos [here](https://docs.yearn.finance/developers/code-repositories). +If you are interested in working on a specific project, check out the list of Yearn products in the [General Resources](#general-resources) section below or check out our list of repos [here](https://docs.yearn.finance/developers/code-repositories). -If you want an overview on how our services interact with one another for Vaults, please see the schema and accompanying descriptions in the [Vaults Overview](https://docs.yearn.finance/developers/yvaults-documentation/vaults-overview). +If you want an overview on how our services interact with one another in Vaults, please see the schema and accompanying descriptions in the [Vaults Overview](https://docs.yearn.finance/developers/yvaults-documentation/vaults-overview). If you're wondering how **strategies** work, please check out [ETHOnline 🛠️ Yearn Strats 101](https://www.youtube.com/watch?v=4gwZk-IaMRs) — hosted by our Yearn Devs. To start writing a Strategy of your own, please visit the [Yearn Starter Pack Repo](https://github.com/iearn-finance/yearn-starter-pack). @@ -64,7 +64,7 @@ We invite designers, animators, artists, and more to share your skills with the ## Yearn Contributors -See our wonderful list of contributors and individual contribution stats at [yContributors.finance](https://ycontributors.finance/). Get your name added to the list by contributing to documentation, code, designs, or whatever else you're interested in! +See our wonderful list of contributors along with individual contribution stats at [yContributors.finance](https://ycontributors.finance/). Get your name added to the list by contributing to documentation, code, designs, or whatever else you're interested in! ## General Resources From d5540cd558e769ecbef1be81d3d77f769eb63cfb Mon Sep 17 00:00:00 2001 From: Daniel Lehnberg Date: Thu, 19 Nov 2020 17:03:11 +0000 Subject: [PATCH 4/5] fix: Correct typo --- contributors/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributors/README.md b/contributors/README.md index eb5ff2c5..80a1ef42 100644 --- a/contributors/README.md +++ b/contributors/README.md @@ -48,7 +48,7 @@ If this sounds confusing, please let us know what we can clear up. In the meanti If you're a developer we need your help! Before you begin: Familiarize yourself with Yearn, its products, and its infrastructure by reading our [Documentation](https://docs.yearn.finance/). -You can see our progress on our [Github Project Board](https://github.com/orgs/iearn-finance/projects/1) and you can immediately begin contributing where you see fit. We recommend checking out issues tagged as `help wanted` and reccommend sticking to the respective repository's coding guidelines (linting, formatting, PRs, etc). It's that simple 🙂. You can also join us on the #dev channel in [Discord](https://discord.com/invite/6PNv2nF). +You can see our progress on our [Github Project Board](https://github.com/orgs/iearn-finance/projects/1) and you can immediately begin contributing where you see fit. We recommend checking out issues tagged as `help wanted` and recommend sticking to the respective repository's coding guidelines (linting, formatting, PRs, etc). It's that simple 🙂. You can also join us on the #dev channel in [Discord](https://discord.com/invite/6PNv2nF). If you are interested in working on a specific project, check out the list of Yearn products in the [General Resources](#general-resources) section below or check out our list of repos [here](https://docs.yearn.finance/developers/code-repositories). From c132c8478bb5e00f7804e2c6d6cfd37611a1ed4b Mon Sep 17 00:00:00 2001 From: Daniel Lehnberg Date: Thu, 19 Nov 2020 17:03:59 +0000 Subject: [PATCH 5/5] Run linter --- contributors/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/contributors/README.md b/contributors/README.md index 80a1ef42..150f2c0d 100644 --- a/contributors/README.md +++ b/contributors/README.md @@ -12,11 +12,11 @@ We are always open to new suggestions or better ways of doing things. If you hav ### File a Bug -If a Yearn product isn't working, please visit the appropriate Github repository listed under [General Resources](#general-resources) — or search in the [Yearn Github Repo](https://github.com/iearn-finance/yearn-protocol) — to see if the issue already exists. +If a Yearn product isn't working, please visit the appropriate Github repository listed under [General Resources](#general-resources) — or search in the [Yearn Github Repo](https://github.com/iearn-finance/yearn-protocol) — to see if the issue already exists. -If it does not exist, please create a new issue following the template present in the repository. +If it does not exist, please create a new issue following the template present in the repository. -If no issue template is present, please include information such as your browser version, device, etc. for that project so the developers can replicate it and fix it. +If no issue template is present, please include information such as your browser version, device, etc. for that project so the developers can replicate it and fix it. If the issue already exists, you can signal your support by adding a thumbs up to the existing issue or by adding helpful information. @@ -26,7 +26,7 @@ Use the [Feedback](https://gov.yearn.finance/c/feedback/2) section of the govern ### Write Documentation -The Yearn ecosystem is expanding and, as a result, so is the need for documentation. You can find the "official" Yearn Documentation [here](https://docs.yearn.finance/) — which provides high-level overviews *and* technical documentation. +The Yearn ecosystem is expanding and, as a result, so is the need for documentation. You can find the "official" Yearn Documentation [here](https://docs.yearn.finance/) — which provides high-level overviews _and_ technical documentation. Whether its writing _How To_ guides on using vaults or creating diagrams on how the protocol ties together, there is something for everyone. If you speak another language, translations might be up your alley! @@ -60,7 +60,7 @@ If you are looking to integrate with Yearn, please visit our [Integration Guide] #### Designers -We invite designers, animators, artists, and more to share your skills with the Yearn ecosystem! If you're interested in creating graphics that describe Yearn's systems, creating video explainers, fixing Yearn's UI/UX, or any other combination of things — hop into the #ui-ux channel or #media-resources channels in [Discord](https://docs.yearn.finance/developers/yvaults-documentation/vault-interfaces). +We invite designers, animators, artists, and more to share your skills with the Yearn ecosystem! If you're interested in creating graphics that describe Yearn's systems, creating video explainers, fixing Yearn's UI/UX, or any other combination of things — hop into the #ui-ux channel or #media-resources channels in [Discord](https://docs.yearn.finance/developers/yvaults-documentation/vault-interfaces). ## Yearn Contributors