Contribute

We're always looking for passionate developers to join our community and contribute to Madara. Check out our contributing guide for more information on how to get started.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Please note we have a code of conduct, please follow it in all your interactions with the project.

Development environment setup

[?] Proceed to describe how to setup local development environment. e.g:

To set up a development environment, please follow these steps:

1. Clone the repo

   git clone https://github.com/keep-starknet-strange/madara
   cd madara
   cargo test

2. TODO

Issues and feature requests

You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? Take a look at GitHub Discussions (opens in a new tab) to see if it's already being discussed. You can help us by submitting an issue on GitHub (opens in a new tab). Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!

Please try to create bug reports that are:

• Reproducible. Include steps to reproduce the problem.
• Specific. Include as much detail as possible: which version, what environment, etc.
• Unique. Do not duplicate existing opened issues.
• Scoped to a Single Bug. One bug per report.

Even better: Submit a pull request with a fix or new feature!

How to submit a Pull Request

1. Search our repository for open or closed Pull Requests (opens in a new tab) that relate to your submission. You don't want to duplicate effort.
2. Fork the project
3. Create your feature branch (git checkout -b feat/amazing_feature)
4. Commit your changes (git commit -m 'feat: add amazing_feature')
5. Push to the branch (git push origin feat/amazing_feature)
6. Open a Pull Request (opens in a new tab)