@betterstore/sdk
Version:
E-commerce for Developers
53 lines (41 loc) β’ 1.44 kB
Markdown
# Contributing to Better Store SDK
π Thank you for your interest in contributing to **Better Store SDK**! Weβre building the best developer experience for eCommerce, and weβd love your help.
## π Getting Started
1. **Fork the repository** and clone your fork locally:
```sh
git clone https://github.com/your-username/better-store-sdk.git
cd better-store-sdk
```
2. **Install dependencies:**
```sh
npm install
```
3. **Run the tests to ensure everything is working:**
```sh
npm test
```
## π Code Guidelines
- Use **TypeScript** for type safety.
- Follow **Prettier** and **ESLint** formatting.
- Keep PRs small and focused on a single issue.
- Write **unit tests** for any new functionality.
## π Submitting a Pull Request
1. **Create a feature branch:**
```sh
git checkout -b feature/new-feature
```
2. **Make your changes and commit them:**
```sh
git add .
git commit -m "β¨ Added new feature"
```
3. **Push your branch:**
```sh
git push origin feature/new-feature
```
4. **Open a Pull Request** on GitHub and describe your changes.
## π Reporting Issues
- Use the [GitHub Issues](https://github.com/your-org/better-store-sdk/issues) to report bugs and request features.
- Provide steps to reproduce bugs if possible.
## β€οΈ Thank You!
Your contributions make **Better Store SDK** awesome. Let's build a better eCommerce experience together! π