Contributing

🤝 Contributing

Thank you for considering contributing to Simple API Router! Contributions help improve the project and make it more useful for everyone. This guide will walk you through how to contribute effectively.

---

📌 How to Contribute

1. Fork the Repository
   Click the Fork button on GitHub and clone your fork locally.

   git clone https://github.com/NotNexx/simple-api-router.git n-sar
   cd n-sar

2. Create a Branch
   Create a new branch for your feature or bug fix.

   git checkout -b feature-name

3. Install Dependencies
   Make sure all dependencies are installed.

   npm install

4. Make Your Changes
   Implement your feature, fix a bug, or improve the documentation.

5. Run Tests
   Ensure all tests pass before submitting a pull request.

   npm test

6. Commit and Push
   Follow the commit message format:

   git commit -m "feat: add new feature description"
   git push origin feature-name

7. Create a Pull Request
   Open a pull request (PR) on GitHub with a clear description of your changes.

---

🛠️ Development Setup

To run the project locally during development:

npm install
npm link

This links the package globally, allowing you to test it in a separate project.

---

📝 Coding Guidelines

• Follow the existing code style.
• Use clear and descriptive commit messages.
• Keep PRs focused on one change at a time.

---

🧪 Testing

All contributions should be tested before submission. Run:

npm test

If you are adding a new feature, consider writing tests to cover it.

---

💡 Feature Requests & Bug Reports

• Open an issue to report a bug or suggest a new feature.
• Before opening an issue, check if a similar issue already exists.

---

🎉 Thank You!

Your contributions make Simple API Router better! If you have any questions, feel free to start a discussion or open an issue.

💡 Need help? Join the [discussions](../discussions) or check out the [issues](../issues).