-
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(readme.md): 📝 update readme and contributing guide
- Loading branch information
Showing
2 changed files
with
49 additions
and
0 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 |
---|---|---|
@@ -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. |
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