Contributing

Development

Clone the repo locally, via git clone https://github.com/mimir-labs/mimir-apps-sdk.git
Ensure that you have a recent version of Node.js, for development purposes Node 18 is recommended.
Ensure that you have a recent version of Yarn, for development purposes Yarn >=1.10.1 is required.
Install the dependencies by running yarn
Test the spec files via yarn test
Build the everything via yarn build

Before you submit your Pull Request (PR) consider the following guidelines:

Make your changes in a new git branch:
```
git checkout -b my-branch master
```
Create your feature or patch, and including appropriate test cases.
Run yarn changeset in the root and describe your changes. The files in .changeset must commit because it be used during release.
Run the full test suite and ensure that all tests pass.
Commit your changes using a descriptive commit message.
```
git commit -a
```
Note: the optional commit -a command line option will automatically "add" and "rm" edited files.
Push your branch to GitHub:
```
git push origin my-branch
```
In GitHub, send a pull request to mimir-apps-sdk:master.
If we suggest changes then:
- Make the required updates.
- Re-run the test suites to ensure tests are still passing.
- Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
```
git rebase master -i
git push -f
```

That's it! Thank you for your contribution!

After your pull request is merged, you can safely delete your branch and pull the changes from the master (upstream) repository:

Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
```
git push origin --delete my-branch
```
Check out the master branch:
```
git checkout master -f
```
Delete the local branch:
```
git branch -D my-branch
```
Update your master with the latest upstream version:
```
git pull --ff upstream master
```