First off, thank you for considering contributing to HireSync! It's people like you that make HireSync such a great tool.
This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.
- Check Existing Issues - Search through existing issues to avoid duplicates
- Create a New Issue using our bug report template
- Include Details:
- Clear title and description
- Steps to reproduce
- Expected vs actual behavior
- Screenshots if applicable
- Your environment details
- Check Existing Suggestions - Search through existing enhancement requests
- Create a New Issue using our feature request template
- Provide Context:
- Use case
- Benefits
- Potential implementation approach
- Fork the Repository
- Create a Branch: ```bash git checkout -b feature/your-feature-name ```
- Make Changes:
- Follow our coding standards
- Add tests if applicable
- Update documentation
- Commit Your Changes:
- Use clear commit messages
- Reference issues and pull requests
- Push to Your Fork
- Open a Pull Request
-
Prerequisites:
- Azure Subscription
- Node.js 18+
- Azure CLI
-
Local Development: ```bash git clone https://github.com/yourusername/hiresync.git cd hiresync npm install ```
- Use TypeScript for type safety
- Follow ESLint configuration
- Write meaningful comments
- Include JSDoc documentation
- Write unit tests for new features
- Update README.md if needed
- Add JSDoc comments for new functions
- Update API documentation
- Include examples for new features
- Join our Discussions
- Follow our Code of Conduct
- Help others in issues and pull requests
Contributors will be recognized in our:
- README.md
- Release notes
- Contributors page
Thank you for contributing to HireSync! 🎉