node-tenancy
Version:
Making multi-tenancy easier with Node.js & typescript
38 lines (25 loc) โข 1.17 kB
Markdown
# Contributing to node-tenancy
Thank you for considering contributing to **node-tenancy**! ๐
This guide will walk you through the process of contributing and how to make your pull request effective and aligned with the goals of the package.
---
## ๐ How You Can Contribute
- ๐ **Report Bugs**
Open an issue describing the bug with steps to reproduce it. Attach logs or error messages when possible.
- ๐ก **Suggest Enhancements**
If you think of a feature or improvement that would benefit the project, feel free to open a feature request.
- ๐งช **Write Tests**
Found an area that needs more testing? Help improve test coverage.
- ๐ **Fix Issues**
Check the issues tab for any that are labeled or `help wanted`.
- ๐ **Improve Documentation**
Spotted a typo or unclear section? Send in a doc fix!
- ๐จ **Style Guide**
- Follow existing coding patterns and structure.
- Write clear, concise commit messages.
- Use consistent formatting (we use ESLint).
---
## ๐งโ๐ป Getting Started
1. **Fork the repository**
2. **Clone your fork**
```bash
git clone https://github.com/YOUR_USERNAME/node-tenancy.git