Skip to content

Contributing guidelines

Ron Erlih edited this page Apr 14, 2024 · 2 revisions

❤️✨ 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 engineering@astral.global
  • 🚀 Add a feature 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 with no develop branch (atm). main <- feature-branch
  • PR format: <type>([optional scope]): <description>

🏗️ Project structure

We are using a forge project from this wonderful template ❤️ all info about structure should be there.

📓 Commits

Often please, and please install the cz-git cli, the config file is in the repo for easy, emoji filled commits.

💅 Style

Please follow solidity-style-guide or do it better :)

❤️ Thank you so much!!

We are working (bullishly) on our incentive structure.