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/.gitignore b/.gitignore index 48a004c..90c9393 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,24 @@ dist-newstyle +dist +dist-* +cabal-dev +*.o +*.hi +*.hie +*.chi +*.chs.h +*.dyn_o +*.dyn_hi +.hpc +.hsenv +.cabal-sandbox/ +cabal.sandbox.config +*.prof +*.aux +*.hp +*.eventlog +.stack-work/ +cabal.project.local +cabal.project.local~ +.HTF/ +.ghc.environment.* \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd7206f..e5f8e10 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,16 +12,14 @@ Use an [existing template](https://github.com/maestro-org/haskell-sdk/issues/new - Request a new feature Accompany your issue with one or more of the following labels: -- `bug` -- `dependencies` -- `documentation` -- `duplicate` -- `github actions` -- `good first issue` -- `haskell` -- `help wanted` -- `vulnerability` -- `wont fix` +- `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: @@ -29,6 +27,6 @@ After opening a pull request, please take the following steps: - [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! +- Merge and celebrate with some nice tunes! 🎼🎼🎼 -The team will do their best to help you get your PRs across the finish line! +The team will do their best to help you get your PRs merged as soon as humanly possible! diff --git a/README.md b/README.md index 8924236..6041316 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,28 @@ -# haskell-sdk - -## Setup - -Get Maestro api key from (https://dashboard.gomaestro.org/login) - -Create Maestro environment - -```haskell - import Maestro.Client.Env - - mEnv <- mkMaestroEnv "api-key" Preprod - - -- we can use maestro environment to access Client Apis (Eg.) - - accountInfo <- Maestro.Client.Accounts.getAccount mEnv "stake_......." - -``` \ No newline at end of file +# Maestro Haskell SDK + +[TODO(Varderes)] Logo goes here + +[TODO(Varderes/Piyush)] 1-3 describing the library and why it exists + +# Installation + +[TODO(Piyush)] + +# Usage + +[TODO(Piyush)] + +## Examples + +[TODO(Piyush)] + +# Testing + +[TODO(Piyush)] + +# Documentation + +All Maestro documentation lives [here](https://docs.gomaestro.org/)! + +# Contributing +Meastro welcomes all contributors! Please see our [contributing guidlines](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md).