First of all, thank you for your interest in contributing to InboxIQ! Your involvement is invaluable, whether you're reporting bugs, suggesting enhancements, or directly improving the code. Here are some guidelines to help you get started.
Please read and follow our Code of Conduct to maintain a respectful and inclusive environment for everyone.
If you've found a bug, please check if it has already been reported under Issues. If not, open a new issue with:
- A descriptive title.
- Steps to reproduce the bug.
- Expected and actual results.
- Additional context (browser, operating system, etc.).
We’re always open to new ideas! If you have a feature request, please:
- Check the existing Issues and Discussions to avoid duplicates.
- Open a feature request issue if it doesn’t exist.
- Clearly describe your feature idea, the problem it solves, and why it would benefit users.
Documentation improvements are always welcome. Feel free to update any part of the README, usage guides, or code comments to make them more helpful.
To submit a pull request:
- Fork this repository.
- Create a new branch (
feature/your-feature-name). - Make your changes following our development guidelines.
- Commit your changes (see Commit Messages).
- Push your branch to GitHub.
- Open a Pull Request and fill out the provided template.
-
Clone the Repository:
git clone https://github.com/yourusername/inboxiq.git cd inboxiq -
Install Dependencies:
npm install
-
Environment Configuration: Set up the
.env.localfile with the required keys (see README.md for details). -
Run the app:
npm run dev
If tests are available, run them with:
npm test