From b881618cb98024f2ab790898162bb0bb2d158265 Mon Sep 17 00:00:00 2001 From: Varderes Barsegyan Date: Fri, 1 Sep 2023 07:18:18 -0600 Subject: [PATCH] bootstrap repo --- .github/CODEOWNERS | 1 + ...-bug---short-description-of-the-problem.md | 31 +++ ...-description-of-the-documentation-issue.md | 17 ++ ...ature--short-description-of-the-feature.md | 20 ++ .github/pull_request_template.md | 40 ++++ CONTRIBUTING.md | 32 +++ LICENSE copy | 201 ++++++++++++++++++ README.md | 30 ++- SECURITY.md | 7 + 9 files changed, 378 insertions(+), 1 deletion(-) create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE/-bug---short-description-of-the-problem.md create mode 100644 .github/ISSUE_TEMPLATE/-docs--short-description-of-the-documentation-issue.md create mode 100644 .github/ISSUE_TEMPLATE/-feature--short-description-of-the-feature.md create mode 100644 .github/pull_request_template.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE copy create mode 100644 SECURITY.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..0bd7208 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @maestro-org/Go \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/-bug---short-description-of-the-problem.md b/.github/ISSUE_TEMPLATE/-bug---short-description-of-the-problem.md new file mode 100644 index 0000000..61c4250 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/-bug---short-description-of-the-problem.md @@ -0,0 +1,31 @@ +--- +name: "[BUG]: Short description of the problem" +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Station (please complete the following information):** + - OS: [e.g. Windows, Ubuntu] + - Version [e.g. 10, 11, 22.02] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/-docs--short-description-of-the-documentation-issue.md b/.github/ISSUE_TEMPLATE/-docs--short-description-of-the-documentation-issue.md new file mode 100644 index 0000000..4a3602d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/-docs--short-description-of-the-documentation-issue.md @@ -0,0 +1,17 @@ +--- +name: "[DOCS] Short description of the documentation issue" +about: Suggest documentation improvements +title: '' +labels: '' +assignees: '' + +--- + +**Describe the issue with the documentation** +A clear and concise description of what the issue is. + +**Suggest a solution** +Describe how the documentation can be improved or corrected. + +**Additional context** +Add any other context, references, or screenshots that might help clarify the issue. diff --git a/.github/ISSUE_TEMPLATE/-feature--short-description-of-the-feature.md b/.github/ISSUE_TEMPLATE/-feature--short-description-of-the-feature.md new file mode 100644 index 0000000..7526a73 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/-feature--short-description-of-the-feature.md @@ -0,0 +1,20 @@ +--- +name: "[FEATURE] Short description of the feature" +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..6214975 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,40 @@ +Thank you for contributing to Maestro! We appreciate your effort and dedication to improving this project. To ensure that your contribution is in line with the project's guidelines and can be reviewed efficiently, please fill out the template below. + +Remember to follow our [Contributing Guide](CONTRIBUTING.md) before submitting your pull request. + +## Summary + +Please provide a brief, concise summary of the changes in your pull request. Explain the problem you are trying to solve and the solution you have implemented. + +## Type of Change + +Please mark the relevant option(s) for your pull request: + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Code refactoring (improving code quality without changing its behavior) +- [ ] Documentation update (adding or updating documentation related to the project) + +## Checklist + +Please ensure that your pull request meets the following criteria: + +- [ ] I have read the [Contributing Guide](CONTRIBUTING.md) +- [ ] My code follows the project's coding style and best practices +- [ ] My code is appropriately commented and includes relevant documentation +- [ ] I have added tests to cover my changes +- [ ] All new and existing tests pass +- [ ] I have updated the documentation, if necessary + +## Testing + +Please describe the tests you have added or modified, and provide any additional context or instructions needed to run the tests. + +- [ ] Test A +- [ ] Test B + +## Additional Information + +If you have any additional information or context to provide, such as screenshots, relevant issues, or other details, please include them here. + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..86f887f --- /dev/null +++ b/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/typescript-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 +- `Go`: something TypeScript 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/typescript-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! diff --git a/LICENSE copy b/LICENSE copy new file mode 100644 index 0000000..339a45e --- /dev/null +++ b/LICENSE copy @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2023 Maestro Blockchain Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 3d6e2e7..0c7c26b 100644 --- a/README.md +++ b/README.md @@ -1 +1,29 @@ -# Maestro Go SDK +

+ + Maestro Logo + +

Go SDK for the Maestro Dapp Platform

+

+ + + + + + + + + + + + + + + +

+

+ +# Getting Started + +# Documentation + +# Contributing diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..1306a48 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,7 @@ +# Security Policy + +## Reporting a Vulnerability + +Please report a Vulnerability with the built-in Github functionality in the *Security* tab : https://github.com/maestro-org/typescript-sdk/security/advisories + +More info here : https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability