readme

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing to Maestro
+
+Welcome! We're happy to have you join our community and contribute to the most powerful Dapp Developer Platform for Cardano!
+
+To learn more about Maestro [here](https://docs.gomaestro.org/)!
+
+## Opening Issues
+
+Use an [existing template](https://github.com/maestro-org/haskell-sdk/issues/new/choose) to:
+- Report a bug
+- Update the docs
+- Request a new feature
+
+Accompany your issue with one or more of the following labels:
+- `Bug`: something is broken in the library's codebase
+- `Chore`: something needs to be updated, like a dependency
+- `CI`: something with Github Actions needs attention
+- `Docs`: something in the documentation needs to be updated
+- `Feature`: something new would be a nice addition to the library
+- `Haskell`: something Haskell related
+- `Vulnerability`: something is vulnerability and needs attention from security
+- `Spike`: something new needs to be explored
+
+## Opening Pull Requests
+After opening a pull request, please take the following steps:
+- Ensure your PR has one or more corresponding issues (see above)
+- [Link your PR](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) to those issues
+- Check the [build status](https://github.com/maestro-org/haskell-sdk/actions/new) of your PR
+- Wait for a review and/or approval from one of the code owners
+- Merge and celebrate with some nice tunes! 🎼🎼🎼
+
+The team will do their best to help you get your PRs merged as soon as humanly possible!

README.md

@@ -1 +1,37 @@
-# Maestro Python SDK
+<p align="center">
+  <a href="https://www.gomaestro.org/">
+    <img src="https://www.gomaestro.org/logos/LandingLogos/DarkLogo.svg" alt="Maestro Logo" width="425" />
+  </a>
+  <h2 align="center">Python SDK for the <a href="https://www.gomaestro.org/">Maestro</a> Dapp Platform</h2>
+  <p align="center">
+    <a href="https://python-sdk.gomaestro.org/">
+      <img src="https://img.shields.io/badge/-RTD-5E5184?style=flat-square&logo=python&logoColor=white" />
+    </a>
+    <a href="https://docs.gomaestro.org/docs/intro">
+      <img src="https://img.shields.io/badge/-Docs-blue?style=flat-square&logo=semantic-scholar&logoColor=white" />
+    </a>
+    <a href="https://github.com/maestro-org/python-sdk/blob/main/LICENSE">
+      <img src="https://img.shields.io/github/license/maestro-org/python-sdk?style=flat-square&label=Licence" />
+    </a>
+    <a href="https://github.com/maestro-org/python-sdk/actions/workflows/build.yml?query=branch%3Amain">
+      <img src="https://img.shields.io/github/actions/workflow/status/maestro-org/python-sdk/build.yml?style=flat-square&branch=main&label=Build" />
+    </a>
+    <a href="./CONTRIBUTING.md">
+      <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" />
+    </a>
+    <a href="https://twitter.com/GoMaestroOrg">
+      <img src="https://img.shields.io/badge/-%40GoMaestroOrg-F3F1EF?style=flat-square&logo=twitter&logoColor=1D9BF0" />
+    </a>
+    <a href="https://discord.gg/ES2rDhBJt3">
+      <img src="https://img.shields.io/badge/-Discord-414EEC?style=flat-square&logo=discord&logoColor=white" />
+    </a>
+  </p>
+</p>
+
+# Getting Started
+
+# Documentation
+
+# Contributing
+
+Meastro welcomes all contributors! Please see our [contributing guidelines](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md).