UNPKG

flexflag

Version:

FlexFlag is a powerful and lightweight feature flag engine

65 lines (45 loc) 1.64 kB
# 🤝 Contributing to Feature Flag Library Thanks for your interest in contributing to FlexFlag project! We welcome bug reports, feature requests, and pull requests. This document will help you get started and ensure a smooth collaboration. --- ## 📝 How to Contribute ### 🔧 Reporting Bugs If you find a bug, please: 1. Review open issues to avoid duplicates. 2. Use our [Bug Report Template](.github/ISSUE_TEMPLATE/BUG_REPORT.md). 3. Include: - Clear description of the issue - Steps to reproduce - Expected vs actual behavior - Logs, screenshots, or error messages (if available) ### 🌟 Requesting a Feature Have an idea for an improvement? Please: 1. Check existing feature requests first. 2. Use our [Feature Request Template](.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md). 3. Be clear about: - What the feature does - Why it's needed - How it might be implemented - Any alternatives you've considered --- ## 🛠️ Submitting a Pull Request We welcome PRs that: - Fix bugs - Improve performance - Add useful features - Improve documentation **Before you open a PR:** - Fork the repo and create a feature branch. - Make sure your code is tested. - Follow existing code style and naming conventions. - Add/update relevant documentation if needed. **When opening a PR:** - Describe the purpose of the PR. - Reference related issues if applicable (`Closes #123`). - Include screenshots or test output if it helps reviewers. --- ## 📦 Project Setup (optional section) <Provide setup instructions here if contributors need to run the project locally, e.g.,> ```bash npm install npm test ```