Skip to content

Commit

Permalink
docs(readme.md): 📝 update readme and contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ronerlih committed Apr 13, 2024
1 parent 6ae1188 commit f433c08
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# ❤️:sparkles: Contributing to Astral

Thank you for taking the time! We are excited to have you! We'd like to make it as easiest to contribute,

We encourage you to:

- ✉️ Send over any question, suggestion, technical issue to our [[email protected]]([email protected])
- 🚀 Add a reature request using the `issue template`.
- 🦸 Add Pull request `pr template`.

## 🌿 GIT Flow

> 💡 Do not worry about conventions, we'll be happy to amend any format, and happy to see other conventions.
We are using a simple [github flow](https://githubflow.github.io/) with no develop branch (atm). `main` <- `feature-branch`
[PR format](https://flank.github.io/flank/pr_titles/): `<type>([optional scope]): <description>`

## 🏗️ Project structure

We are using a forge project from this wonderful [template](https://github.com/PaulRBerg/foundry-template) ❤️ all info about structure
should be there.

## 📓 Commits

Often please, and please install the [cz-git](https://github.com/Zhengqbbb/cz-git) cli, the config file is in the repo for easy, eamoji
filled commits.

## 💅 Style

Please follow [solidity-style-guide](https://github.com/ethereum/solidity/blob/develop/docs/style-guide.rst) or do it better :)

## ❤️ Thank you so much!!

We are working (bullishly) on our incentive structure.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[![Github Actions][gha-badge]][gha] [![Foundry][foundry-badge]][foundry] [![License: MIT][license-badge]][license]
[![codecov][codecov-badge]][codecov]
[![Twitter](https://img.shields.io/twitter/follow/astralprotocol?style=social)](https://twitter.com/astralprotocol)

[gitpod-badge]: https://img.shields.io/badge/Gitpod-Open%20in%20Gitpod-FFB45B?logo=gitpod
[gha]: https://github.com/AstralProtocol/astralprotocol/actions
Expand All @@ -10,3 +11,17 @@
[license-badge]: https://img.shields.io/badge/License-MIT-blue.svg
[codecov]: https://codecov.io/gh/AstralProtocol/astralprotocol
[codecov-badge]: https://codecov.io/gh/AstralProtocol/astralprotocol/graph/badge.svg?token=8MPT8407FS

![astralDAO](https://github.com/astralDAO/overview/blob/master/brand-identity/Transparent-Logo-Only-Astral.png?raw=true)

# Astral Protocol

Deploy, extend, and maintain GeoLocation apps in a decentralized environment.

## Design

![Astral-diagram](https://github.com/AstralProtocol/astralprotocol/assets/7093389/562936df-c748-4527-a743-33f6520bac64)

## ❤️ Contribute

Please check our contributing guide! We deeply appreciate any help, review, suggestion!

0 comments on commit f433c08

Please sign in to comment.