@robylon/whatsapp-react-sdk 1.0.0-staging.1

package/CONTRIBUTING.md

@@ -0,0 +1,133 @@
+# Contributing to Robylon Web React SDK
+
+This guide is for developers contributing to the Robylon Web React SDK.
+
+## Development Setup
+
+1. Clone the repository
+
+```bash
+git clone https://github.com/OneWorldNation/robylon-whatsapp-sdk.git
+cd robylon-whatsapp-sdk
+```
+
+2. Install dependencies
+
+```bash
+npm install
+```
+
+## Branching Strategy
+
+We follow a trunk-based development model with the following branches:
+
+> ⚠️ **Important**: Always create new branches using `npm run branch`
+> Direct branch creation (git checkout -b) is disabled to ensure version control.
+
+### Main Branch
+
+- Single source of truth
+- Always contains production-ready code
+- Only receives merges from release branches
+
+### Feature Branches: `feature/v{future-version}/{feature-name}`
+
+- Used for developing new features
+- Contains work-in-progress code
+- Must be merged into release branch when complete
+- Example: `feature/v1.1.15/add-chat-widget`
+
+### Release Branches: `release/v{version}`
+
+- Collects all features for a specific version
+- Created when ready to release a new version
+- Used for final testing and preparation
+- Merged into main when ready for production
+- Example: `release/v1.1.15`
+
+### Hotfix Branches: `hotfix/v{version}-patch.{number}`
+
+- Used for fixing issues in older versions
+- Branched from specific version tags
+- Example: `hotfix/v1.1.14-patch.1`
+
+## Git Hooks
+
+This project uses Git hooks to enforce branch naming conventions. The hooks are automatically installed when you run `npm install`.
+
+If you need to reinstall the hooks manually:
+
+```bash
+npm run postinstall
+```
+
+## Build and Test
+
+- Development build: `npm run build:development`
+- Staging build: `npm run build:staging`
+- Production build: `npm run build:production`
+- Run tests: `npm test`
+- Watch tests: `npm run test:watch`
+- Lint code: `npm run lint`
+- Fix lint issues: `npm run lint:fix`
+
+## Publishing
+
+### Staging
+
+```bash
+npm run publish:staging
+```
+
+### Production
+
+```bash
+npm run publish:production
+```
+
+### Branch Flow
+
+1. Create feature branches for new work
+2. Develop and test features independently
+3. When all features for a version are ready:
+   - Create a release branch
+   - Merge all related feature branches into it
+4. Test the release branch thoroughly
+5. When ready:
+   - Merge release branch into main
+   - Run publish:production
+   - Tag is automatically created
+
+### Publishing Process
+
+1. For new versions:
+
+   Run the release process from your release branch:
+
+   ```bash
+   git checkout release/v1.1.15
+   npm run release
+   ```
+
+   This will automatically:
+
+   1. Validate the release branch
+   2. Check for version conflicts
+   3. Publish to npm
+   4. Create git tag
+   5. Merge to main
+
+2. For hotfixes:
+   ```bash
+   # From hotfix branch
+   git checkout hotfix/v1.1.14-patch.1
+   npm run publish:hotfix
+   ```
+
+## Version Control
+
+### Tags
+
+- Each release is tagged (e.g., `v1.1.14`)
+- Tags are created automatically after publishing
+- Use tags to checkout specific versions