-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Contributing_refresh * Contributing * Contributing_130623 * contributing_130692 * bc * sidebar_feedback_split * update contribution section, typos (#522) * MVP_50723 * Update docs/explore/introduction/contributing.md Co-authored-by: Derek Croote <[email protected]> * Update docs/explore/introduction/contributing.md Co-authored-by: Derek Croote <[email protected]> * Update docs/explore/introduction/contributing.md Co-authored-by: Derek Croote <[email protected]> * Update docs/explore/introduction/contributing.md Co-authored-by: Derek Croote <[email protected]> * Update docs/explore/introduction/contributing.md Co-authored-by: Derek Croote <[email protected]> * formatting&feedbackreview * review * review * review2 * review --------- Co-authored-by: Erich Dylus <[email protected]> Co-authored-by: TimesThreeDX <[email protected]> Co-authored-by: Derek Croote <[email protected]>
- Loading branch information
1 parent
41f9111
commit b40dd21
Showing
3 changed files
with
197 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: Contributing | ||
title: API3 DAO Welcomes Community Participation | ||
sidebarHeader: Explore | ||
sidebarSubHeader: | ||
pageHeader: Explore | ||
|
@@ -16,78 +16,151 @@ tags: | |
|
||
# {{$frontmatter.title}} | ||
|
||
API3 is open to any proposals and improvements. Please feel free to contribute. | ||
We think critical infrastructure, like API3 DAO's first-party oracles, should | ||
implement open and transparent contributor processes to align with our vision of | ||
being a programmatically driven protocol. | ||
|
||
To support DAO governance and inform voters, all teams publish a public proposal | ||
at regular intervals, meaning strategy & operations are accessible on the | ||
[API3 Governance Forum](https://forum.api3.org/) for all to understand. | ||
Additionally, teams generally update the community with ongoing reports. | ||
|
||
## Types of contributors | ||
|
||
Community participants within a Decentralized Autonomous Organization (DAO) have | ||
an active role in shaping the future of the project. Our aim is to simplify the | ||
process for those who wish to participate, providing predefined methods for | ||
engagement. Generally these take three forms: | ||
|
||
- Core team contributions | ||
- Completion of pre-defined bounties | ||
- New initiatives or ideas | ||
|
||
### Contributors can engage with proposals made by the core teams | ||
|
||
If contributors feel they possess particular skills or expertise that may | ||
benefit the proposal's execution, they can directly communicate with the | ||
proposal leads. This collaborative approach encourages a diverse array of | ||
viewpoints and fosters a proactive culture where everyone's skills and | ||
experiences are leveraged for the benefit of the DAO's objectives. | ||
|
||
### Take on pre-defined bounties | ||
|
||
Community participants have the opportunity to engage with pre-set bounties, | ||
organized in a modular structure to offer clear and attainable tasks. For | ||
instance, a bounty might be created for a specific job that is expected to be | ||
completed within two days. This structure allows any member of the community to | ||
take on the job, complete it, and subsequently receive the designated grant as a | ||
reward retrospectively. | ||
|
||
### Submit your own proposal | ||
|
||
We welcome proposals that bring new ideas or sub-teams to the DAO. Generally | ||
engaging the DAO through our community in a constructive manner will help | ||
sentiment check a proposal and help shape it to align to current contributors. | ||
If you are proposing an initiative that would require collaboration with a | ||
current sub team, we suggest coordinating proactively and outlining how you will | ||
work together. | ||
|
||
## Put forward your ideas to the API3 DAO | ||
|
||
Regardless of the contributor's skill, API3's vision is for participation to be | ||
as frictionless as possible. Individuals with a relevant background can | ||
contribute to the project in a flexible manner, replicating similar | ||
freelancer/consultancy type models commonly seen. | ||
|
||
### Technical contributors | ||
|
||
For technical folks this could be through development, integrations, writing | ||
documentation, etc. Although the general challenge is that one needs to be able | ||
to use a solution proficiently before being able to improve it. If this applies | ||
we suggest digesting the [get started materials](index.md). | ||
|
||
To begin with, this contribution may look like: | ||
|
||
- opening issues | ||
- making pull requests | ||
- proposing features | ||
|
||
Individuals with a technical background can contribute to the project (through | ||
development, integrations, writing documentation, etc.). The general point is | ||
that one needs to be able to use a solution proficiently before being able to | ||
improve it. | ||
### To get started | ||
|
||
## Prerequisites | ||
|
||
It is recommended to do all of the below before attempting to contribute, and | ||
make sure to ask any questions you have on | ||
[Discord<ExternalLinkImage/>](https://discord.gg/qnRrcfnm5W). | ||
We recommend spending some time learning about API3 DAO's oracle technology | ||
before looking to contribute from an engineer perspective. We welcome you to ask | ||
any questions on [Discord<ExternalLinkImage/>](https://discord.gg/qnRrcfnm5W). | ||
|
||
- Read the entirety of these docs. Take notes and cross-reference, but do not | ||
expect to understand everything. Feel free to ask questions. | ||
- Visit the [API3 GitHub<externalLinkImage/>](https://github.com/api3dao) page | ||
to explore the many repositories of API3's oracle stack and gain in-depth | ||
knowledge. | ||
- Head to the | ||
[API3 Community Hub](https://github.com/api3-ecosystem/doc-hub.git) with get | ||
started tutorials & demo projects. | ||
- Go through the issues, PRs, etc. and understand the current focus of the | ||
development team by viewing the development board. | ||
|
||
### If you are learning about blockchain & oracles | ||
|
||
- Read the | ||
[getting started<ExternalLinkImage/>](docs/explore/introduction/index.md) | ||
section in the API3 Docs | ||
- (For the curious) Explore the API3 codebase on | ||
[GitHub<ExternalLinkImage/>](https://github.com/api3dao) | ||
- If you do not have any blockchain development experience, read | ||
[Mastering Ethereum<ExternalLinkImage/>](https://github.com/ethereumbook/ethereumbook) | ||
cover to cover. It is a light read that touches on all subjects that you will | ||
need to know about superficially. | ||
|
||
- To get a general grasp of the project, read the | ||
<a href="/api3-whitepaper-v1.0.3.pdf" target="_api3-whitepaper">API3 | ||
Whitepaper<ExternalLinkImage/></a> and our | ||
[Blog Posts on Medium<ExternalLinkImage/>](https://medium.com/api3). | ||
### Non-technical contributors | ||
|
||
- Read the entirety of these docs. Take notes and cross-reference, but do not | ||
expect to understand everything. Feel free to ask questions. | ||
Marketers, creatives and community builders can contribute to DAO with ad-hoc | ||
projects or to support specific areas within subteams. The challenge here is | ||
accurately scoping, forming a brief proposed solution method, and then | ||
delivering in alignment with other involved contributors. | ||
|
||
Among many other types, contributions may look like: | ||
|
||
- Run and understand the Airnode starter tutorial | ||
- blog posts, community resources | ||
- ambassador activity, setting of events | ||
- graphic design, creative | ||
- testers, user research | ||
|
||
- (Optional, but ideal) Integrate an API to an Airnode without using any guide, | ||
deploy the Airnode, and build a dApp that uses the Airnode. Better yet, join | ||
one of our hackathons. | ||
## How do I access funds to support my efforts? | ||
|
||
- (For the curious) Explore all the repos hosted on | ||
[GitHub<ExternalLinkImage/>](https://github.com/api3dao), go through the | ||
issues, PRs, etc. | ||
Prospective contributors should provide a clear scope of work with (1) detailed | ||
deliverables and estimations of completion time (2) any applicable coordination | ||
with other contributors necessary to accomplish the deliverables and (3) the | ||
amount of API3 tokens requested. | ||
|
||
This page will be updated as more materials are produced. Please feel free to | ||
create | ||
[GitHub issues<ExternalLinkImage/>](https://github.com/api3dao/vitepress-docs/issues) | ||
to make suggestions. | ||
We appreciate the individual nature of contributing and these frameworks are | ||
flexible, yet linking these activities to the challenges outlined in team | ||
proposals will support our holistic objectives and be more likely supported. | ||
|
||
## GitHub | ||
### Ecosystem fast bounties & retrospective grants | ||
|
||
Visit the [API3 GitHub<externalLinkImage/>](https://github.com/api3dao) page and | ||
find everything about.. everything. Explore the many repositories to gain | ||
in-depth knowledge about API3. | ||
The API3 Ecosystem team has a dedicated pool of funds to support micro-grants | ||
from community contributors. This can be retrospective or pre-planned, but has | ||
been created to make rewarding contribution frictionless and simple. | ||
|
||
- the whitepaper | ||
- source code | ||
- documentation | ||
- usage examples | ||
### Submit a proposal to the DAO | ||
|
||
Please feel free to contribute to any API3 GitHub repositories. | ||
- Join the API3 [community<ExternalLinkImage/>](https://discord.gg/qnRrcfnm5W) | ||
and submit within the ecosystem contributor request channel. | ||
- Submit an overview and sentiment check onto the | ||
[API3 forums](https://forum.api3.org/). | ||
- Follow the | ||
[proposal guidelines](https://docs.api3.org/guides/dao-members/proposals.html#proposal-creation) | ||
provided by API3 DAO. | ||
- Email [email protected] with an overview | ||
|
||
## Communities | ||
Within this process we welcome open dialogue and as a DAO recognize that | ||
external contributors and diversity in thought is a strength. | ||
|
||
Join the API3 community on the following services. | ||
### We invite all curious contributors to engage API3 | ||
|
||
- [API3 Forum<ExternalLinkImage/>](https://forum.api3.org/) | ||
- Community Chat on [Telegram<ExternalLinkImage/>](https://t.me/API3DAO) | ||
- Developer Chat on [Discord<ExternalLinkImage/>](https://discord.gg/qnRrcfnm5W) | ||
- [YouTube Channel<ExternalLinkImage/>](https://www.youtube.com/channel/UCCpUthOhahxjdeX9T7t7nJQ) | ||
|
||
## Contributing to the Technical Documentation | ||
|
||
See the [dev documentation](/dev/) for an overview of the API3 technical | ||
documentation site. It contains instructions on the make-up of the docs and on | ||
how to clone, setup, and run the project locally. For non-DAO members a PR from | ||
a fork is always welcome. | ||
|
||
<FlexEndTag/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
--- | ||
title: Feedback | ||
sidebarHeader: Explore | ||
sidebarSubHeader: | ||
pageHeader: Explore | ||
path: /explore/introduction/feedback.html | ||
outline: deep | ||
tags: | ||
--- | ||
|
||
<PageHeader/> | ||
|
||
<SearchHighlight/> | ||
|
||
<FlexStartTag/> | ||
|
||
# {{$frontmatter.title}} to the API3 docs | ||
|
||
We always appreciate your thoughts and suggestions about our documentation. | ||
Whether it's concerning the presentation of the information, or even provided | ||
through our feedback template, we're eager to hear your feedback. | ||
|
||
### Feedback or sharing ideas | ||
|
||
If you are reading our documentation and have ideas on how we can better present | ||
or communicate these concepts we would like to hear from you. | ||
|
||
This might include scenarios such as: | ||
|
||
- Ideas for us to communicate technical ideas in a simpler way | ||
- Areas that you think we could emphasize the 'why' behind our technical design | ||
- Points of difference within API3 that you think we should further highlight or | ||
communicate | ||
|
||
Please email [email protected] with the subject "Documentation feedback | ||
submission". | ||
|
||
### Submit an issue | ||
|
||
We welcome all developers to contribute to the growth and enhancement of API3 | ||
DAO by submitting any issues or suggestions you come across via our issue | ||
template. Your insight is invaluable in making our technology better. | ||
|
||
Please submit to https://github.com/api3dao/vitepress-docs/issues. | ||
|
||
::: tip Feedback is valuable | ||
|
||
Feedback is valuable and any submission shared with be rewarded with a | ||
retrospective bounty of up to $250 of API3 | ||
|
||
::: | ||
|
||
## Contributing to the Technical Documentation | ||
|
||
See the [dev documentation](/dev/) for an overview of the API3 technical | ||
documentation site. It contains instructions on the make-up of the docs and on | ||
how to clone, setup, and run the project locally. For non-DAO members a PR from | ||
a fork is always welcome. | ||
|
||
You can also see the [Contributing](/docs/explore/introduction/contributing.md) | ||
overview on how to engage further. | ||
|
||
<!--### Join the API3 testers guild | ||
API3 Testers Guild is a community of professionals involved to testing API3 | ||
products & services. The Guild often conducts workshops, webinars, and | ||
conferences to foster a dynamic and up-to-date understanding of testing in the | ||
evolving tech landscape.--> | ||
|
||
<FlexEndTag/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters