Skip to content

Commit

Permalink
Merge pull request #91 from Arrow-air/staging
Browse files Browse the repository at this point in the history
Staging to main
  • Loading branch information
owlot authored Mar 4, 2024
2 parents cdbcead + 48211f3 commit 1762ab2
Show file tree
Hide file tree
Showing 7 changed files with 64 additions and 70 deletions.
2 changes: 2 additions & 0 deletions .cspell.project-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -123,3 +123,5 @@ vertipads
autosquash
esbenp
johnsoncodehk
permissionless
stablecoins
2 changes: 1 addition & 1 deletion .make/base.mk
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
SHELL := /bin/bash

SANITYCHECKS_IMAGE_NAME := ghcr.io/arrow-air/tools/arrow-sanitychecks
SANITYCHECKS_IMAGE_TAG := 0.2
SANITYCHECKS_IMAGE_TAG := 0.3

SOURCE_PATH ?= $(PWD)

Expand Down
44 changes: 27 additions & 17 deletions docs/contributing/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,66 +6,76 @@ sidebar_position: 1

The best way to get connected with the Arrow community and start working is to join our Discord server!

Introduce yourself in the `#introductions` channel and we'll all be happy to get you up to speed - we're a friendly bunch!
Introduce yourself in the `#general` channel and we'll all be happy to get you up to speed - we're a friendly bunch!

:exclamation: As a general rule of culture, you don't need formal permission to start working on anything. However, it's best to communicate well with the community to keep us all aligned and working on high-impact tasks.

See the [Development Guide](./guides/development-guide.md) for contributions our GitHub repositories.
See the [Development Guide](./guides/development-guide.md) for contributions to our GitHub repositories.

To ensure that you have a smooth contributing experience (and get paid fairly 😊), we created this page to include every technology and documentation we used to establish our workflows and compensation frameworks.

We highly recommend you bookmark this page if you want to be actively involved.

## :busts_in_silhouette: Collaboration

### [Discord](https://discord.com/invite/arrow)
We use Discord to exchange ideas, schedule meetings, and send memes around. Arrow's Discord channel is the best place to keep up with Arrow's development and hang out with other contributors.

We use Discord to exchange ideas, schedule meetings, and send memes around. Arrow's Discord channel is the best place to keep up with Arrow's development and hang out with other contributors. All of our meetings happen and are scheduled through Discord - join them!

### [GitHub](https://github.com/Arrow-air)

Everything we do is open-sourced. Software and hardware engineering works can be found from our repositories.

### [Dework](https://app.dework.xyz/arrow-air)

Dework is a web3-native collaboration platform that allows for tasks/bounties management. Contributors can sync up their Discord roles to Dework and get compensated. Dework is also a good place to see what people are working on and their progress.

## :money_with_wings: Compensation

There are multiple ways to get compensated:
* Commitment Track: active contributors will get paid by a combination of Arrow tokens and USDC stable coins. Think of this as the "base salary" of a traditional job. Of course, we provide flexibility on your commitment level. See below for more information.
* Bonus: Each contributor has 1,000 ARROW each month to "tip" other contributors to appreciate their works. This is done in Coordinape (see below).
* Bounties: Complete bounties on Dework will be paid in USDC or ARROW, or a mix of both.

* Bounties: Complete bounties on Dework will be paid in USDC or ARROW, or a mix of both. These will be specific tasks that have a defined scope ahead of time.
* Grants: If you have an idea for something that you think would benefit Arrow, you can pitch it to us and we may give you a grant to work on it. Similar to a bounty, we will set milestones and USDC/ARROW payouts. We also strive to issue retroactive grants when contributions are made without any compensation plan set ahead of time. Send a message in `#general` if you have a grant idea or think someone deserves a retroactive grant.
* Commitment Track: Our core contributors are paid by a combination of Arrow tokens and USDC stablecoins. Think of this as the "base salary" of a traditional job. Of course, we provide flexibility on your commitment level. See below for more information. If you're interested in progressing to commitment track, start with some bounties and grants first to get integrated with Arrow.
* Bonus: Each regular contributor has 1,000 ARROW each month to "tip" other contributors to appreciate their works. This is done in Coordinape (see below).

:exclamation: As of now, we're still finalizing the details of our Arrow token, but we will make sure that all contributors are retroactively rewarded for all of their hard work. We strive to have a culture of merit - If you contribute something valuable, you will be rewarded.

### [Coordinape](https://app.coordinape.com/)

Contributors can see what other contributors are doing/have done in a given month and have 1,000 ARROW tokens to allocate to other contributors to show their appreciation.

### [LlamaPay](https://llamapay.io/)

Contributors admitted to the Commitment Track will be able to receive USDC and Arrow token vesting through LlamaPay, a web3 product that pays you **per second**. It's super cool!

## :scroll: Docs

Contributors who are interested in the Commitment Track should monitor Discord for each period's sign-up announcements. Usually, the sign-up is done by filling out a Google Form.

[**Arrow Compensation Framework**](https://docs.google.com/document/d/1GbhslaFcHT1w2zCWbtLFafrsW_QIZ7fxcQXicGOa5Hw/edit?usp=sharing): The most detailed explanation of Arrow's compensation framework. This is the single source of truth from which compensation tools are configured.

[**Arrow Contributor Compensation Workbook**](https://docs.google.com/spreadsheets/d/1Mngt2VHdpZgCwRceVHUqXD9ufMx2gninVBPxm0RkXRQ/edit?usp=sharing): Outlines requirements for different levels of expertise and a brief compensation scenario analysis.

[**ARROW Initial Allocation and Management [DRAFT]**](https://docs.google.com/document/d/19yGuWkonvxdYrXz8rXYAXg1EwEluPGvrLS64dcmEK6Y/edit?usp=sharing): Outlines the proposed token allocation for founding contributors. It also provides a breakdown of the use of the ARROW treasury.

## :link: Important Links

### [HammerTime](https://hammertime.cyou/)

Our contributors are located across the globe! HammerTime allows you to share a date/time in the Discord and convert it to localized format, so that contributors can see the correct time in their respective timezones.

### [Arrow Drive](https://drive.google.com/drive/folders/1efLrzqsiajzlxXiOUjxPT53CkfDGC0Yu?usp=sharing)

The Google Drive stores important paperwork, engineering concepts, presentations, brand artworks, and more.

## :wave: Contributor Introduction Pages

Can't find your introduction page? You can add it yourself!
1. Copy the contents of the [contributors template](https://raw.githubusercontent.com/Arrow-air/website/main/docs/contributing/contributors/_template.md)
2. Go to [the contributors directory in GitHub](https://github.com/Arrow-air/website/tree/main/docs/contributing/contributors)
3. Select `Add file` -> `Create new file`
4. Paste the contents you copied from the template
5. Fill out the template with your own information (you can use the `preview` to see if you're happy with the result)
6. Create a PR from a new branch
![image](/images/create_pr.jpg)
7. Your PR will be reviewed for approval. If everything looks ok, your PR will be approved and merged.

1. Copy the contents of the [contributors template](https://raw.githubusercontent.com/Arrow-air/website/main/docs/contributing/contributors/_template.md)
2. Go to [the contributors directory in GitHub](https://github.com/Arrow-air/website/tree/main/docs/contributing/contributors)
3. Select `Add file` -> `Create new file`
4. Paste the contents you copied from the template
5. Fill out the template with your own information (you can use the `preview` to see if you're happy with the result)
6. Create a PR from a new branch
![image](/images/create_pr.jpg)
7. Your PR will be reviewed for approval. If everything looks ok, your PR will be approved and merged.
9 changes: 0 additions & 9 deletions docs/contributing/jobs.md

This file was deleted.

33 changes: 33 additions & 0 deletions docs/contributing/projects.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
sidebar_position: 7
---

# Pending Projects

This page will serve as a general list of some ideas for DAO projects that we would like to pursue further. If any of these are of interest to you, send a message in Discord and we may be able to set up a grant.

### Flight Test Tracking Platform

As we expand our flight tests, there will be a need for some more organization of the test data. We've discussed the idea for an tool that would let us record each test flight with the type of aircraft hardware used, log files, video recordings, and any notes from the flight. We imagine people flying with many variations of hardware, so keeping things organized could be a unique challenge.

Getting started on this would require someone to take ownership on developing the concept further with input from other DAO members and creating some UI mockups of the tool.

### Safety Critical RTOS

As we've investigated building an open source flight controller stack for manned aviation, we've realized that one major barrier is the lack of an open source real time operating system that we can build on top of. Arrow would like to help build this as a good for the world. We'd want to adhere to SIL-3 and DO-178C in the development process. This is a difficult and lengthy undertaking and we'd need very high confidence in the team taking it on.

We'd hope to partner with other projects that would benefit from an open source safety critical RTOS to help share the burden. Getting started on this would require a experienced engineer to begin organizing the project. See this [Discord thread](https://discord.com/channels/853833144037277726/1103816452131266651/1103816452131266651) for more context.

### Version Control/Better Management Tools for Decentralized Hardware Development

This could be split into multiple different projects. We've felt some friction in the development and organization process for our hardware that we think could be solved by some better tooling. Early work on this would be to thoughtfully think through the problems to be solved and scope, then to create some UI mockups. Some features we've discussed:

- "Github for hardware"

- Listing and organization of all our CAD files with context for manufacturing

- Fork-ability of parts and part -> assembly management

- Easy and permissionless onboarding for new contributors to get to work with our CAD files

- A "place order" button that routes the order to a nearby Arrow workshop or approved supplier for fulfillment
2 changes: 1 addition & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ All of the business logic for Arrow will live on the Ethereum blockchain. This w

#### How is open-source hardware possible?

As software technology advances, we can do more and more of the engineering process without a physical presence. Instead of machined prototypes and wind tunnels, we can use CAD models and CFD testing. This type of virtual iteration will be expanding to almost the entire engineering stack over the next decade.
As software technology advances, we can do more and more of the engineering process without a physical presence. Instead of machined prototypes and wind tunnels, we can use CAD models and CFD analysis. This type of virtual iteration will be expanding to almost the entire engineering stack over the next decade.

Blockchain technology allows us to easily reward contributors for their ideas. Alignment of incentives is much easier now that we are able to establish a culture of rewarding valuable ideas with a token allocation.

Expand Down
42 changes: 0 additions & 42 deletions src/pages/foundingengineerjob.md

This file was deleted.

0 comments on commit 1762ab2

Please sign in to comment.