Initial commit

amika-sq · Mar 6, 2023 · bf0ca52 · bf0ca52
commit bf0ca52
Show file tree

Hide file tree

Showing 6 changed files with 678 additions and 0 deletions.
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -0,0 +1,24 @@
+# This CODEOWNERS file denotes the project leads
+# and encodes their responsibilities for code review.
+
+# Instructions: At a minimum, replace the '@GITHUB_USER_NAME_GOES_HERE'
+# here with at least one project lead.
+
+# Lines starting with '#' are comments.
+# Each line is a file pattern followed by one or more owners.
+# The format is described: https://github.blog/2017-07-06-introducing-code-owners/
+
+# These owners will be the default owners for everything in the repo.
+*       @GITHUB_USER_NAME_GOES_HERE
+
+
+# -----------------------------------------------
+# BELOW THIS LINE ARE TEMPLATES, UNUSED
+# -----------------------------------------------
+# Order is important. The last matching pattern has the most precedence.
+# So if a pull request only touches javascript files, only these owners
+# will be requested to review.
+# *.js    @octocat @github/js
+
+# You can also use email addresses if you prefer.
+# docs/*  [email protected]
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,136 @@
+
+# TBD Code of Conduct
+
+TBD builds infrastructure for the next wave of innovation in financial services — which we believe will be decentralized, permissionless, and non-custodial. This means opening the global economy to everyone. We extend the same principles of inclusion to our developer ecosystem. We are excited to build with you. So we will ensure our community is truly open, transparent and inclusive. Because of the global nature of our project, diversity and inclusivity is paramount to our success. We not only welcome diverse perspectives, we **need** them!
+
+The code of conduct below reflects the expectations for ourselves and for our community.
+
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, physical appearance, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, 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 and welcoming 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
+
+The TBD Open Source Governance Committee (GC) is 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.
+
+The GC has 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 project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event, or any space where the project is listed as part of your profile.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the TBD Open Source Governance Committee (GC) at
+`[email protected]`.
+All complaints will be reviewed and investigated promptly and fairly.
+
+The GC is obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+The GC 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 the GC, 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 and forums. 
+
+Although this list cannot be exhaustive, we explicitly honor diversity in age, culture, ethnicity, gender identity or expression, language, national origin, political beliefs, profession, race, religion, sexual orientation, socioeconomic status, and technical ability. We will not tolerate discrimination based on any of the protected characteristics above, including participants with disabilities.
+
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,214 @@
+# Contribution Guide 
+
+There are many ways to be an open source contributor, and we're here to help you on your way! You may:
+
+* Propose ideas in our 
+  [discussion forums](https://forums.tbd.website)
+* Raise an issue or feature request in our [issue tracker](LINK_HERE)  ___***FIX LINK AND REMOVE THIS NOTICE***___
+* Help another contributor with one of their questions, or a code review
+* Suggest improvements to our Getting Started documentation by supplying a Pull Request
+* Evangelize our work together in conferences, podcasts, and social media spaces.
+
+This guide is for you.
+
+## Development Prerequisites
+
+___***UPDATE TABLE OF PROJECT DEPS AND INSTALLATION NOTES***___
+
+| Requirement | Tested Version | Installation Instructions                            |
+|-------------|----------------|------------------------------------------------------|
+| Go          | 1.17.6         |[go.dev](https://go.dev/doc/tutorial/compile-install) |
+| Mage        | 1.12.1         |[magefile.org](https://magefile.org/)                 |
+| Java        | 17.0.2         | Below, recommended via [SDKMan](https://sdkman.io)   |
+
+### Go
+
+This project is written in Go, a modern, open source programming language. 
+
+You may verify your `go` installation via the terminal:
+
+```
+$> go version
+go version go1.17.6 darwin/amd64
+```
+
+If you do not have go, we recommend installing it by:
+
+#### MacOS
+
+##### Homebrew
+```
+$> brew install go
+```
+
+#### Linux
+
+See the [Go Installation Documentation](https://go.dev/doc/install).
+
+### Mage
+
+The build is run by Mage.
+
+You may verify your `mage` installation via the terminal:
+
+```
+$> mage --version
+Mage Build Tool 1.12.1
+Build Date: 2021-12-15T21:00:02Z
+Commit: 2f1ec40
+built with: go1.17.6
+```
+
+#### MacOS
+
+##### Homebrew
+
+```
+$> brew install mage
+```
+
+#### Linux
+
+Installation instructions are on the [Magefile home page](https://magefile.org/).
+
+### Java
+
+This project is written in Java, a typesafe, compiled programming language. 
+
+You may verify your `java` installation via the terminal by running `java -version`.
+
+If you do not have Java, we recommend installing it 
+via [SDKMan](https://sdkman.io/install). This is a project which will allow you 
+to easily install the Java Development Kit (JDK), runtime (JRE), and related frameworks, 
+build tools, and runtimes.
+
+After you've installed SDKMan, you may install Java:
+
+#### SDKMan (cross-platform instructions)
+
+```shell
+$> sdk install java 
+ ...
+Do you want java 17.0.2-open to be set as default? (Y/n): Y
+Setting java 17.0.2-open as default.
+```
+
+You may test your installation:
+
+```shell
+$> java -version
+openjdk version "17.0.2" 2022-01-18
+OpenJDK Runtime Environment (build 17.0.2+8-86)
+OpenJDK 64-Bit Server VM (build 17.0.2+8-86, mixed mode, sharing)
+```
+
+---
+**NOTE**
+
+You may additionally look for other Java versions to install by running `sdk list java`:
+
+...or other installation candidates like Apache Ant, Apache Maven, etc, by running `sdk list`.
+
+Consult the SDKMan documentation for more info.
+
+---
+
+## Build (Mage)
+
+```
+$> mage build
+```
+
+## Build (Java / Gradle)
+
+### macOS / Linux
+```shell
+$> ./gradlew build
+```
+
+### Windows
+```shell
+$> gradlew.bat build
+```
+
+## Test (Mage)
+
+```
+$> mage test
+```
+
+## Test (Java / Gradle)
+
+### macOS / Linux
+```shell
+$> ./gradlew test
+```
+
+### Windows
+```shell
+$> gradlew.bat test
+```
+
+---
+**NOTE**
+
+You may also combine Gradle build targets in one call, like:
+
+```shell
+$> ./gradlew clean build test
+```
+
+---
+
+## Communications
+
+### Issues
+
+Anyone from the community is welcome (and encouraged!) to raise issues via 
+[GitHub Issues](LINK_HERE)  ___***FIX LINK AND REMOVE THIS NOTICE***___.
+
+### Discussions
+
+Design discussions and proposals take place on our [discussion forums](https://forums.tbd.website).
+
+We advocate an asynchronous, written debate model - so write up your thoughts and invite the community to join in!
+
+### Continuous Integration
+
+Build and Test cycles are run on every commit to every branch on [CircleCI](LINK_HERE).
+
+ ___***FIX LINK ABOVE AND REMOVE THIS NOTICE***___
+
+## Contribution
+
+We review contributions to the codebase via GitHub's Pull Request mechanism. We have 
+the following guidelines to ease your experience and help our leads respond quickly 
+to your valuable work:
+
+* Start by proposing a change either in Issues (most appropriate for small 
+  change requests or bug fixes) or in Discussions (most appropriate for design 
+  and architecture considerations, proposing a new feature, or where you'd 
+  like insight and feedback)
+* Cultivate consensus around your ideas; the project leads will help you 
+  pre-flight how beneficial the proposal might be to the project. Developing early 
+  buy-in will help others understand what you're looking to do, and give you a 
+  greater chance of your contributions making it into the codebase! No one wants to 
+  see work done in an area that's unlikely to be incorporated into the codebase.
+* Fork the repo into your own namespace/remote
+* Work in a dedicated feature branch. Atlassian wrote a great 
+  [description of this workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow)
+* When you're ready to offer your work to the project, first:
+* Squash your commits into a single one (or an appropriate small number of commits), and 
+  rebase atop the upstream `main` branch. This will limit the potential for merge 
+  conflicts during review, and helps keep the audit trail clean. A good writeup for 
+  how this is done is 
+  [here](https://medium.com/@slamflipstrom/a-beginners-guide-to-squashing-commits-with-git-rebase-8185cf6e62ec), and if you're 
+  having trouble - feel free to ask a member or the community for help or leave the commits as-is, and flag that you'd like 
+  rebasing assistance in your PR! We're here to support you.
+* Open a PR in the project to bring in the code from your feature branch.
+* The maintainers noted in the `CODEOWNERS` file will review your PR and optionally 
+  open a discussion about its contents before moving forward.
+* Remain responsive to follow-up questions, be open to making requested changes, and...
+  You're a contributor!
+* And remember to respect everyone in our global development community. Guidelines 
+  are established in our `CODE_OF_CONDUCT.md`.